Amazon Textract Textract Adapter Version API

openapi: 3.2.0
info:
  title: Amazon Textract Adapter Version API
  version: '2018-06-27'
  description: Generated from AWS's published Smithy model for Amazon Textract. 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://textract.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Adapter Version
paths:
  /#CreateAdapterVersion:
    post:
      operationId: CreateAdapterVersion
      summary: Create Adapter Version
      description: Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAdapterVersionResponse'
        '400':
          description: AccessDeniedException; ConflictException; IdempotentParameterMismatchException; InvalidKMSKeyException; InvalidParameterException; InvalidS3ObjectException; LimitExceededException; ProvisionedThroughputExceededException; ResourceNotFoundException; ServiceQuotaExceededException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Textract.CreateAdapterVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAdapterVersionRequest'
      tags:
      - Adapter Version
  /#DeleteAdapterVersion:
    post:
      operationId: DeleteAdapterVersion
      summary: Delete Adapter Version
      description: Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAdapterVersionResponse'
        '400':
          description: AccessDeniedException; ConflictException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Textract.DeleteAdapterVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAdapterVersionRequest'
      tags:
      - Adapter Version
  /#GetAdapterVersion:
    post:
      operationId: GetAdapterVersion
      summary: Get Adapter Version
      description: 'Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetAdapterVersionResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Textract.GetAdapterVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetAdapterVersionRequest'
      tags:
      - Adapter Version
  /#ListAdapterVersions:
    post:
      operationId: ListAdapterVersions
      summary: List Adapter Versions
      description: List all version of an adapter that meet the specified filtration criteria.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAdapterVersionsResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerError; ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Textract.ListAdapterVersions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAdapterVersionsRequest'
      tags:
      - Adapter Version
components:
  schemas:
    ListAdapterVersionsRequest:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter to match for when listing adapter versions.
        AfterCreationTime:
          type: string
          format: date-time
          description: Specifies the lower bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.
        BeforeCreationTime:
          type: string
          format: date-time
          description: Specifies the upper bound for the ListAdapterVersions operation. Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.
        MaxResults:
          type: integer
          description: The maximum number of results to return when listing adapter versions.
        NextToken:
          type: string
          description: Identifies the next page of results to return when listing adapter versions.
    GetAdapterVersionResponse:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter version being retrieved.
        AdapterVersion:
          type: string
          description: A string containing the adapter version that has been retrieved.
        CreationTime:
          type: string
          format: date-time
          description: The time that the adapter version was created.
        FeatureTypes:
          type: array
          items:
            type: string
            enum:
            - TABLES
            - FORMS
            - QUERIES
            - SIGNATURES
            - LAYOUT
          description: List of the targeted feature types for the requested adapter version.
        Status:
          type: string
          enum:
          - ACTIVE
          - AT_RISK
          - DEPRECATED
          - CREATION_ERROR
          - CREATION_IN_PROGRESS
          description: The status of the adapter version that has been requested.
        StatusMessage:
          type: string
          description: A message that describes the status of the requested adapter version.
        DatasetConfig:
          $ref: '#/components/schemas/AdapterVersionDatasetConfig'
        KMSKeyId:
          type: string
          description: The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
        OutputConfig:
          $ref: '#/components/schemas/OutputConfig'
        EvaluationMetrics:
          type: array
          items:
            $ref: '#/components/schemas/AdapterVersionEvaluationMetric'
          description: The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A set of tags (key-value pairs) that are associated with the adapter version.
    AdapterVersionDatasetConfig:
      type: object
      properties:
        ManifestS3Object:
          $ref: '#/components/schemas/S3Object'
    CreateAdapterVersionRequest:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter that will receive a new version.
        ClientRequestToken:
          type: string
          description: Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapterVersion requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
        DatasetConfig:
          $ref: '#/components/schemas/AdapterVersionDatasetConfig'
        KMSKeyId:
          type: string
          description: The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
        OutputConfig:
          $ref: '#/components/schemas/OutputConfig'
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A set of tags (key-value pairs) that you want to attach to the adapter version.
      required:
      - AdapterId
      - DatasetConfig
      - OutputConfig
    GetAdapterVersionRequest:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string specifying a unique ID for the adapter version you want to retrieve information for.
        AdapterVersion:
          type: string
          description: A string specifying the adapter version you want to retrieve information for.
      required:
      - AdapterId
      - AdapterVersion
    CreateAdapterVersionResponse:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing the unique ID for the adapter that has received a new version.
        AdapterVersion:
          type: string
          description: A string describing the new version of the adapter.
    DeleteAdapterVersionRequest:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter version that will be deleted.
        AdapterVersion:
          type: string
          description: Specifies the adapter version to be deleted.
      required:
      - AdapterId
      - AdapterVersion
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    AdapterVersionEvaluationMetric:
      type: object
      properties:
        Baseline:
          $ref: '#/components/schemas/EvaluationMetric'
        AdapterVersion:
          $ref: '#/components/schemas/EvaluationMetric'
        FeatureType:
          type: string
          enum:
          - TABLES
          - FORMS
          - QUERIES
          - SIGNATURES
          - LAYOUT
          description: Indicates the feature type being analyzed by a given adapter version.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    EvaluationMetric:
      type: object
      properties:
        F1Score:
          type: number
          description: The F1 score for an adapter version.
        Precision:
          type: number
          description: The Precision score for an adapter version.
        Recall:
          type: number
          description: The Recall score for an adapter version.
    OutputConfig:
      type: object
      properties:
        S3Bucket:
          type: string
          description: The name of the bucket your output will go to.
        S3Prefix:
          type: string
          description: The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".
      required:
      - S3Bucket
    DeleteAdapterVersionResponse:
      type: object
      properties: {}
    ListAdapterVersionsResponse:
      type: object
      properties:
        AdapterVersions:
          type: array
          items:
            $ref: '#/components/schemas/AdapterVersionOverview'
          description: Adapter versions that match the filtering criteria specified when calling ListAdapters.
        NextToken:
          type: string
          description: Identifies the next page of results to return when listing adapter versions.
    S3Object:
      type: object
      properties:
        Bucket:
          type: string
          description: 'The name of the S3 bucket. Note that the # character is not valid in the file name.'
        Name:
          type: string
          description: The file name of the input document. Image files may be in PDF, TIFF, JPEG, or PNG format.
        Version:
          type: string
          description: If the bucket has versioning enabled, you can specify the object version.
    AdapterVersionOverview:
      type: object
      properties:
        AdapterId:
          type: string
          description: A unique identifier for the adapter associated with a given adapter version.
        AdapterVersion:
          type: string
          description: An identified for a given adapter version.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that a given adapter version was created.
        FeatureTypes:
          type: array
          items:
            type: string
            enum:
            - TABLES
            - FORMS
            - QUERIES
            - SIGNATURES
            - LAYOUT
          description: The feature types that the adapter version is operating on.
        Status:
          type: string
          enum:
          - ACTIVE
          - AT_RISK
          - DEPRECATED
          - CREATION_ERROR
          - CREATION_IN_PROGRESS
          description: Contains information on the status of a given adapter version.
        StatusMessage:
          type: string
          description: A message explaining the status of a given adapter vesion.
  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: textract
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/textract/service/2018-06-27/textract-2018-06-27.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)