Amazon Kendra FA Qs API

openapi: 3.2.0
info:
  title: Amazon Kendra FAQs API
  version: '2019-02-03'
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  description: 'Operations tagged FAQs across 2 of this provider''s published API definitions: amazon-kendra-openapi.yml, amazon-kendra-faqs-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://kendra.{region}.amazonaws.com
  description: Amazon Kendra regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-2
      - eu-west-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-northeast-1
security:
- sigv4: []
tags:
- name: FAQs
  description: Operations for managing FAQ entries
paths:
  /indexes/{IndexId}/faqs:
    post:
      operationId: CreateFaq
      summary: Amazon Kendra Create FAQ
      description: Creates a set of frequently asked questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
      tags:
      - FAQs
      parameters:
      - name: IndexId
        in: path
        required: true
        schema:
          type: string
        description: The identifier of the index.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - Name
              - S3Path
              - RoleArn
              properties:
                Name:
                  type: string
                  description: The name that should be associated with the FAQ.
                  example: example-value
                S3Path:
                  type: object
                  description: The S3 location of the FAQ input data.
                RoleArn:
                  type: string
                  description: The Amazon Resource Name (ARN) of an IAM role.
                  example: example-value
                Description:
                  type: string
                  description: The description of the FAQ.
                FileFormat:
                  type: string
                  description: The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request - invalid input parameters
        '403':
          description: Access denied - insufficient permissions
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListFaqs
      summary: Amazon Kendra List FAQs
      description: Gets a list of FAQ lists associated with an index.
      tags:
      - FAQs
      parameters:
      - name: IndexId
        in: path
        required: true
        schema:
          type: string
        description: The identifier of the index.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request - invalid input parameters
        '403':
          description: Access denied - insufficient permissions
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://kendra.{region}.amazonaws.com
      description: Amazon Kendra regional endpoint
      variables:
        region:
          default: us-east-1
          description: AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-2
          - eu-west-1
          - ap-southeast-1
          - ap-southeast-2
          - ap-northeast-1
  /indexes/{IndexId}/faqs/{FaqId}:
    get:
      operationId: DescribeFaq
      summary: Amazon Kendra Describe FAQ
      description: Gets information about an FAQ list.
      tags:
      - FAQs
      parameters:
      - name: IndexId
        in: path
        required: true
        schema:
          type: string
        description: The identifier of the index.
      - name: FaqId
        in: path
        required: true
        schema:
          type: string
        description: The identifier of the FAQ.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request - invalid input parameters
        '403':
          description: Access denied - insufficient permissions
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: DeleteFaq
      summary: Amazon Kendra Delete FAQ
      description: Removes an FAQ from an index.
      tags:
      - FAQs
      parameters:
      - name: IndexId
        in: path
        required: true
        schema:
          type: string
        description: The identifier of the index.
      - name: FaqId
        in: path
        required: true
        schema:
          type: string
        description: The identifier of the FAQ.
      responses:
        '200':
          description: Success
        '400':
          description: Bad request - invalid input parameters
        '403':
          description: Access denied - insufficient permissions
        '500':
          description: Internal server error
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://kendra.{region}.amazonaws.com
      description: Amazon Kendra regional endpoint
      variables:
        region:
          default: us-east-1
          description: AWS region
          enum:
          - us-east-1
          - us-east-2
          - us-west-2
          - eu-west-1
          - ap-southeast-1
          - ap-southeast-2
          - ap-northeast-1
  /#CreateFaq:
    post:
      operationId: post#CreateFaq
      summary: Create Faq
      description: Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket. Adding FAQs to an index is an asynchronous operation. For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateFaqResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.CreateFaq
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateFaqRequest'
      tags:
      - FAQs
      x-operation-id-source: normalized
      x-operation-id-original: CreateFaq
    servers:
    - url: https://kendra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DeleteFaq:
    post:
      operationId: post#DeleteFaq
      summary: Delete Faq
      description: Removes a FAQ from an index.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.DeleteFaq
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteFaqRequest'
      tags:
      - FAQs
      x-operation-id-source: normalized
      x-operation-id-original: DeleteFaq
    servers:
    - url: https://kendra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#DescribeFaq:
    post:
      operationId: post#DescribeFaq
      summary: Describe Faq
      description: Gets information about a FAQ.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeFaqResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.DescribeFaq
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeFaqRequest'
      tags:
      - FAQs
      x-operation-id-source: normalized
      x-operation-id-original: DescribeFaq
    servers:
    - url: https://kendra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /#ListFaqs:
    post:
      operationId: post#ListFaqs
      summary: List Faqs
      description: Gets a list of FAQs associated with an index.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListFaqsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.ListFaqs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListFaqsRequest'
      tags:
      - FAQs
      x-operation-id-source: normalized
      x-operation-id-original: ListFaqs
    servers:
    - url: https://kendra.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    DescribeFaqResponse:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the FAQ.
        IndexId:
          type: string
          description: The identifier of the index for the FAQ.
        Name:
          type: string
          description: The name that you gave the FAQ when it was created.
        Description:
          type: string
          description: The description of the FAQ that you provided when it was created.
        CreatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the FAQ was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the FAQ was last updated.
        S3Path:
          $ref: '#/components/schemas/S3Path'
        Status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The status of the FAQ. It is ready to use when the status is ACTIVE.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the IAM role that provides access to the S3 bucket containing the FAQ file.
        ErrorMessage:
          type: string
          description: If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
        FileFormat:
          type: string
          enum:
          - CSV
          - CSV_WITH_HEADER
          - JSON
          description: The file format used for the FAQ file.
        LanguageCode:
          type: string
          description: The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, data source, or other resource.
        Value:
          type: string
          description: The value associated with the tag. The value may be an empty string but it can't be null.
      required:
      - Key
      - Value
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    FaqSummary:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the FAQ.
        Name:
          type: string
          description: The name that you assigned the FAQ when you created or updated the FAQ.
        Status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.
        CreatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the FAQ was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The Unix timestamp when the FAQ was last updated.
        FileFormat:
          type: string
          enum:
          - CSV
          - CSV_WITH_HEADER
          - JSON
          description: The file type used to create the FAQ.
        LanguageCode:
          type: string
          description: The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    CreateFaqResponse:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the FAQ.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    ListFaqsRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The index for the FAQs.
        NextToken:
          type: string
          description: If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of FAQs.
        MaxResults:
          type: integer
          description: The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.
      required:
      - IndexId
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    CreateFaqRequest:
      type: object
      properties:
        IndexId:
          type: string
          description: The identifier of the index for the FAQ.
        Name:
          type: string
          description: A name for the FAQ.
        Description:
          type: string
          description: A description for the FAQ.
        S3Path:
          $ref: '#/components/schemas/S3Path'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ file. For more information, see IAM access roles for Amazon Kendra.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
        FileFormat:
          type: string
          enum:
          - CSV
          - CSV_WITH_HEADER
          - JSON
          description: The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes. The default format is CSV. The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter. For more information, see Adding questions and answers.
        ClientToken:
          type: string
          description: A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
        LanguageCode:
          type: string
          description: The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
      required:
      - IndexId
      - Name
      - S3Path
      - RoleArn
    DeleteFaqRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the FAQ you want to remove.
        IndexId:
          type: string
          description: The identifier of the index for the FAQ.
      required:
      - Id
      - IndexId
    DescribeFaqRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the FAQ you want to get information on.
        IndexId:
          type: string
          description: The identifier of the index for the FAQ.
      required:
      - Id
      - IndexId
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    S3Path:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the S3 bucket that contains the file.
        Key:
          type: string
          description: The name of the file.
      required:
      - Bucket
      - Key
    ListFaqsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of FAQs.
        FaqSummaryItems:
          type: array
          items:
            $ref: '#/components/schemas/FaqSummary'
          description: Summary information about the FAQs for a specified index.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
x-refined-from:
- amazon-kendra-openapi.yml
- amazon-kendra-faqs-api-openapi.yml