Amazon Transcribe Transcribe Language Model API

openapi: 3.1.0
info:
  title: Amazon Transcribe Service Language Model API
  version: '2017-10-26'
  description: Generated from AWS's published Smithy model for Amazon Transcribe Service. 5 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://transcribe.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateLanguageModel:
    post:
      operationId: CreateLanguageModel
      summary: Create Language Model
      description: 'Creates a new custom language model. When creating a new custom language model, you must specify: If you
        want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model
        The location of your training and tuning files (this must be an Amazon S3 URI) The language of your model A unique
        name for your model'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLanguageModelResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.CreateLanguageModel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLanguageModelRequest'
      tags:
      - Language Model
  /#DeleteLanguageModel:
    post:
      operationId: DeleteLanguageModel
      summary: Delete Language Model
      description: Deletes a custom language model. To use this operation, specify the name of the language model you want
        to delete using ModelName. custom language model names are case sensitive.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.DeleteLanguageModel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteLanguageModelRequest'
      tags:
      - Language Model
  /#DescribeLanguageModel:
    post:
      operationId: DescribeLanguageModel
      summary: Describe Language Model
      description: Provides information about the specified custom language model. This operation also shows if the base language
        model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base
        model, you can create a new custom language model using the updated base model. If you tried to create a new custom
        language model and the request wasn't successful, you can use DescribeLanguageModel to help identify the reason for
        this failure.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLanguageModelResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.DescribeLanguageModel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLanguageModelRequest'
      tags:
      - Language Model
  /#ListLanguageModels:
    post:
      operationId: ListLanguageModels
      summary: List Language Models
      description: Provides a list of custom language models that match the specified criteria. If no criteria are specified,
        all custom language models are returned. To get detailed information about a specific custom language model, use the
        operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListLanguageModelsResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.ListLanguageModels
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListLanguageModelsRequest'
      tags:
      - Language Model
  /#UpdateLanguageModel:
    post:
      operationId: UpdateLanguageModel
      summary: Update Language Model
      description: Updates the encryption configuration for an existing custom language model. You can use this operation
        to change the KMS key used to encrypt your model artifacts. The model artifacts are re-encrypted in place. No model
        training is required. Your custom language model must not be in the IN_PROGRESS state when you call this operation.
        You cannot submit another update while a previous update is in progress. Use to check the current state of your model.
        Your custom language model remains available for transcription jobs while the update is being processed.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLanguageModelResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.UpdateLanguageModel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLanguageModelRequest'
      tags:
      - Language Model
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: transcribe
  schemas:
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateLanguageModelRequest:
      type: object
      properties:
        LanguageCode:
          type: string
          enum:
          - en-US
          - hi-IN
          - es-US
          - en-GB
          - en-AU
          - de-DE
          - ja-JP
          description: The language code that represents the language of your model. Each custom language model must contain
            terms in only one language, and the language you select for your custom language model must match the language
            of your training and tuning data. For a list of supported languages and their associated language codes, refer
            to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe
            Medical. A custom language model can only be used to transcribe files in the same language as the model. For example,
            if you create a custom language model usi
        BaseModelName:
          type: string
          enum:
          - NarrowBand
          - WideBand
          description: 'The Amazon Transcribe standard language model, or base model, used to create your custom language
            model. Amazon Transcribe offers two options for base models: Wideband and Narrowband. If the audio you want to
            transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate
            less than 16,000 Hz, choose NarrowBand.'
        ModelName:
          type: string
          description: A unique name, chosen by you, for your custom language model. This name is case sensitive, cannot contain
            spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom language model
            with the same name as an existing custom language model, you get a ConflictException error.
        InputDataConfig:
          $ref: '#/components/schemas/InputDataConfig'
        EncryptionConfiguration:
          $ref: '#/components/schemas/EncryptionConfiguration'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model
            at the time you create this new model. To learn more about using tags with Amazon Transcribe, refer to Tagging
            resources.
      required:
      - LanguageCode
      - BaseModelName
      - ModelName
      - InputDataConfig
    CreateLanguageModelResponse:
      type: object
      properties:
        LanguageCode:
          type: string
          enum:
          - en-US
          - hi-IN
          - es-US
          - en-GB
          - en-AU
          - de-DE
          - ja-JP
          description: The language code you selected for your custom language model.
        BaseModelName:
          type: string
          enum:
          - NarrowBand
          - WideBand
          description: The Amazon Transcribe standard language model, or base model, you specified when creating your custom
            language model.
        ModelName:
          type: string
          description: The name of your custom language model.
        InputDataConfig:
          $ref: '#/components/schemas/InputDataConfig'
        ModelStatus:
          type: string
          enum:
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          description: The status of your custom language model. When the status displays as COMPLETED, your model is ready
            to use.
    DeleteLanguageModelRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the custom language model you want to delete. Model names are case sensitive.
      required:
      - ModelName
    DescribeLanguageModelRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the custom language model you want information about. Model names are case sensitive.
      required:
      - ModelName
    DescribeLanguageModelResponse:
      type: object
      properties:
        LanguageModel:
          $ref: '#/components/schemas/LanguageModel'
    EncryptionConfiguration:
      type: object
      properties:
        KMSEncryptionContext:
          type: object
          additionalProperties:
            type: string
          description: A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an
            added layer of security for your data. For more information, see KMS encryption context.
        KMSKey:
          type: string
          description: 'The Amazon Resource Name (ARN) of the KMS key you want to use to encrypt your resource artifacts.
            Only full KMS key ARN format is supported. KMS key ARNs have the format arn:partition:kms:region:account:key/key-id.
            For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. For more information,
            see KMS key ARNs.'
      required:
      - KMSKey
    InputDataConfig:
      type: object
      properties:
        S3Uri:
          type: string
          description: 'The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
            Here''s an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/'
        TuningDataS3Uri:
          type: string
          description: 'The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
            Here''s an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/'
        DataAccessRoleArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket
            that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access
            the specified Amazon S3 location, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
            For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.'
      required:
      - S3Uri
      - DataAccessRoleArn
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
    LanguageModel:
      type: object
      properties:
        ModelName:
          type: string
          description: A unique name, chosen by you, for your custom language model. This name is case sensitive, cannot contain
            spaces, and must be unique within an Amazon Web Services account.
        CreateTime:
          type: string
          format: date-time
          description: The date and time the specified custom language model was created. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC.
            For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time the specified custom language model was last modified. Timestamps are in the format
            YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May
            4, 2022.
        LanguageCode:
          type: string
          enum:
          - en-US
          - hi-IN
          - es-US
          - en-GB
          - en-AU
          - de-DE
          - ja-JP
          description: The language code used to create your custom language model. Each custom language model must contain
            terms in only one language, and the language you select for your custom language model must match the language
            of your training and tuning data. For a list of supported languages and their associated language codes, refer
            to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe
            Medical.
        BaseModelName:
          type: string
          enum:
          - NarrowBand
          - WideBand
          description: The Amazon Transcribe standard language model, or base model, used to create your custom language model.
        ModelStatus:
          type: string
          enum:
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          description: The status of the specified custom language model. When the status displays as COMPLETED the model
            is ready for use.
        UpgradeAvailability:
          type: boolean
          description: Shows if a more current base model is available for use with the specified custom language model. If
            false, your custom language model is using the most up-to-date base model. If true, there is a newer base model
            available than the one your language model is using. Note that to update a base model, you must recreate the custom
            language model using the new base model. Base model upgrades for existing custom language models are not supported.
        FailureReason:
          type: string
          description: 'If ModelStatus is FAILED, FailureReason contains information about why the custom language model request
            failed. See also: Common Errors.'
        InputDataConfig:
          $ref: '#/components/schemas/InputDataConfig'
        EncryptionConfiguration:
          $ref: '#/components/schemas/EncryptionConfiguration'
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    ListLanguageModelsRequest:
      type: object
      properties:
        StatusEquals:
          type: string
          enum:
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          description: Returns only custom language models with the specified status. Language models are ordered by creation
            date, with the newest model first. If you do not include StatusEquals, all custom language models are returned.
        NameContains:
          type: string
          description: Returns only the custom language models that contain the specified string. The search is not case sensitive.
        NextToken:
          type: string
          description: If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed
            in the response with an associated string. To get the next page of results, copy this string and repeat your request,
            including NextToken with the value of the copied string. Repeat as needed to view all your results.
        MaxResults:
          type: integer
          description: The maximum number of custom language models to return in each page of results. If there are fewer
            results than the value that you specify, only the actual results are returned. If you do not specify a value,
            a default of 5 is used.
    ListLanguageModelsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If NextToken is present in your response, it indicates that not all results are displayed. To view
            the next set of results, copy the string associated with the NextToken parameter in your results output, then
            run your request again including NextToken with the value of the copied string. Repeat as needed to view all your
            results.
        Models:
          type: array
          items:
            $ref: '#/components/schemas/LanguageModel'
          description: Provides information about the custom language models that match the criteria specified in your request.
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The first part of a key:value pair that forms a tag associated with a given resource. For example,
            in the tag Department:Sales, the key is 'Department'.
        Value:
          type: string
          description: The second part of a key:value pair that forms a tag associated with a given resource. For example,
            in the tag Department:Sales, the value is 'Sales'. Note that you can set the value of a tag to an empty string,
            but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
      required:
      - Key
      - Value
    UpdateLanguageModelRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the custom language model you want to update. Model names are case sensitive.
        DataAccessRoleArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of an IAM role. If you include EncryptionConfiguration in your request,
            this role must have permissions to access the specified KMS key. If the role that you specify doesn''t have the
            appropriate permissions, your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
            For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.'
        EncryptionConfiguration:
          $ref: '#/components/schemas/EncryptionConfiguration'
      required:
      - ModelName
    UpdateLanguageModelResponse:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the custom language model that was updated.
        ModelStatus:
          type: string
          enum:
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          description: The status of the specified custom language model.
        LastModifiedTime:
          type: string
          format: date-time
          description: The date and time the specified custom language model was last modified.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/transcribe/service/2017-10-26/transcribe-2017-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)