find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-kendra:amazon-kendra-data-source-sync-job-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWSKendraFrontendService Data Source Sync Job API
  version: '2019-02-03'
  description: Generated from AWS's published Smithy model for AWSKendraFrontendService. 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://kendra.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Data Source Sync Job
paths:
  /#ListDataSourceSyncJobs:
    post:
      operationId: ListDataSourceSyncJobs
      summary: List Data Source Sync Jobs
      description: Gets statistics about synchronizing a data source connector.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListDataSourceSyncJobsResponse'
        '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.ListDataSourceSyncJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListDataSourceSyncJobsRequest'
      tags:
      - Data Source Sync Job
  /#StartDataSourceSyncJob:
    post:
      operationId: StartDataSourceSyncJob
      summary: Start Data Source Sync Job
      description: Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception. Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartDataSourceSyncJobResponse'
        '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'
        '400':
          description: ResourceInUseException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceInUseException'
        '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'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSKendraFrontendService.StartDataSourceSyncJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartDataSourceSyncJobRequest'
      tags:
      - Data Source Sync Job
  /#StopDataSourceSyncJob:
    post:
      operationId: StopDataSourceSyncJob
      summary: Stop Data Source Sync Job
      description: Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
      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'
        '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.StopDataSourceSyncJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopDataSourceSyncJobRequest'
      tags:
      - Data Source Sync Job
components:
  schemas:
    StartDataSourceSyncJobRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the data source connector to synchronize.
        IndexId:
          type: string
          description: The identifier of the index used with the data source connector.
      required:
      - Id
      - IndexId
    DataSourceSyncJobMetrics:
      type: object
      properties:
        DocumentsAdded:
          type: string
          description: The number of documents added from the data source up to now in the data source sync.
        DocumentsModified:
          type: string
          description: The number of documents modified in the data source up to now in the data source sync run.
        DocumentsDeleted:
          type: string
          description: The number of documents deleted from the data source up to now in the data source sync run.
        DocumentsFailed:
          type: string
          description: The number of documents that failed to sync from the data source up to now in the data source sync run.
        DocumentsScanned:
          type: string
          description: The current number of documents crawled by the current sync job in the data source.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    DataSourceSyncJob:
      type: object
      properties:
        ExecutionId:
          type: string
          description: A identifier for the synchronization job.
        StartTime:
          type: string
          format: date-time
          description: The Unix timestamp when the synchronization job started.
        EndTime:
          type: string
          format: date-time
          description: The Unix timestamp when the synchronization job completed.
        Status:
          type: string
          enum:
          - FAILED
          - SUCCEEDED
          - SYNCING
          - INCOMPLETE
          - STOPPING
          - ABORTED
          - SYNCING_INDEXING
          description: The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
        ErrorMessage:
          type: string
          description: If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
        ErrorCode:
          type: string
          enum:
          - InternalError
          - InvalidRequest
          description: If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
        DataSourceErrorCode:
          type: string
          description: If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
        Metrics:
          $ref: '#/components/schemas/DataSourceSyncJobMetrics'
    TimeRange:
      type: object
      properties:
        StartTime:
          type: string
          format: date-time
          description: The Unix timestamp for the beginning of the time range.
        EndTime:
          type: string
          format: date-time
          description: The Unix timestamp for the end of the time range.
    ResourceInUseException:
      type: object
      properties:
        Message:
          type: string
    ListDataSourceSyncJobsResponse:
      type: object
      properties:
        History:
          type: array
          items:
            $ref: '#/components/schemas/DataSourceSyncJob'
          description: A history of synchronization jobs for the data source connector.
        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 jobs.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    StartDataSourceSyncJobResponse:
      type: object
      properties:
        ExecutionId:
          type: string
          description: Identifies a particular synchronization job.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ListDataSourceSyncJobsRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the data source connector.
        IndexId:
          type: string
          description: The identifier of the index used with the data source connector.
        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 jobs.
        MaxResults:
          type: integer
          description: The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
        StartTimeFilter:
          $ref: '#/components/schemas/TimeRange'
        StatusFilter:
          type: string
          enum:
          - FAILED
          - SUCCEEDED
          - SYNCING
          - INCOMPLETE
          - STOPPING
          - ABORTED
          - SYNCING_INDEXING
          description: Only returns synchronization jobs with the Status field equal to the specified status.
      required:
      - Id
      - IndexId
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
    StopDataSourceSyncJobRequest:
      type: object
      properties:
        Id:
          type: string
          description: The identifier of the data source connector for which to stop the synchronization jobs.
        IndexId:
          type: string
          description: The identifier of the index used with the data source connector.
      required:
      - Id
      - IndexId
  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: kendra
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/kendra/service/2019-02-03/kendra-2019-02-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)