Amazon Translate Translation API

openapi: 3.1.0
info:
  title: Amazon Translate Translation API
  version: '2017-07-01'
  description: Generated from AWS's published Smithy model for Amazon Translate. 1 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://translate.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#TranslateText:
    post:
      operationId: TranslateText
      summary: Translate Text
      description: Translates input text from the source language to the target language. For a list of available languages
        and language codes, see Supported languages.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TranslateTextResponse'
        '400':
          description: DetectedLanguageLowConfidenceException; InvalidRequestException; TextSizeLimitExceededException; UnsupportedLanguagePairException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DetectedLanguageLowConfidenceException'
        '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'
        '503':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSShineFrontendService_20170701.TranslateText
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/TranslateTextRequest'
      tags:
      - Translation
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: translate
  schemas:
    AppliedTerminology:
      type: object
      properties:
        Name:
          type: string
          description: The name of the custom terminology applied to the input text by Amazon Translate for the translated
            text response.
        Terms:
          type: array
          items:
            $ref: '#/components/schemas/Term'
          description: The specific terms of the custom terminology applied to the input text by Amazon Translate for the
            translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the
            first 250 terms in the source text.
    DetectedLanguageLowConfidenceException:
      type: object
      properties:
        Message:
          type: string
        DetectedLanguageCode:
          type: string
          description: The language code of the auto-detected language from Amazon Comprehend.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    ServiceUnavailableException:
      type: object
      properties:
        Message:
          type: string
    Term:
      type: object
      properties:
        SourceText:
          type: string
          description: The source text of the term being translated by the custom terminology.
        TargetText:
          type: string
          description: The target text of the term being translated by the custom terminology.
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
    TranslateTextRequest:
      type: object
      properties:
        Text:
          type: string
          description: The text to translate. The text string can be a maximum of 10,000 bytes long. Depending on your character
            set, this may be fewer than 10,000 characters.
        TerminologyNames:
          type: array
          items:
            type: string
          description: The name of a terminology list file to add to the translation job. This file provides source terms
            and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use
            one custom terminology resource in your translation request. Use the ListTerminologies operation to get the available
            terminology lists. For more information about custom terminology lists, see Custom terminology.
        SourceLanguageCode:
          type: string
          description: The language code for the language of the source text. For a list of language codes, see Supported
            languages. To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode
            field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language. If
            you specify auto, you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise,
            the request returns an error indicating that autodetect is not supported.
        TargetLanguageCode:
          type: string
          description: The language code requested for the language of the target text. For a list of language codes, see
            Supported languages.
        Settings:
          $ref: '#/components/schemas/TranslationSettings'
      required:
      - Text
      - SourceLanguageCode
      - TargetLanguageCode
    TranslateTextResponse:
      type: object
      properties:
        TranslatedText:
          type: string
          description: The translated text.
        SourceLanguageCode:
          type: string
          description: The language code for the language of the source text.
        TargetLanguageCode:
          type: string
          description: The language code for the language of the target text.
        AppliedTerminologies:
          type: array
          items:
            $ref: '#/components/schemas/AppliedTerminology'
          description: The names of the custom terminologies applied to the input text by Amazon Translate for the translated
            text response.
        AppliedSettings:
          $ref: '#/components/schemas/TranslationSettings'
      required:
      - TranslatedText
      - SourceLanguageCode
      - TargetLanguageCode
    TranslationSettings:
      type: object
      properties:
        Formality:
          type: string
          enum:
          - FORMAL
          - INFORMAL
          description: You can specify the desired level of formality for translations to supported target languages. The
            formality setting controls the level of formal language usage (also known as register) in the translation output.
            You can set the value to informal or formal. If you don't specify a value for formality, or if the target language
            doesn't support formality, the translation will ignore the formality setting. If you specify multiple target languages
            for the job, translate ignores the formality setting for any unsupported target language. For a list of target
            languages that support formality, see Supp
        Profanity:
          type: string
          enum:
          - MASK
          description: You can enable the profanity setting if you want to mask profane words and phrases in your translation
            output. To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This
            5-character sequence is used for each profane word or phrase, regardless of the length or number of words. Amazon
            Translate doesn't detect profanity in all of its supported languages. For languages that don't support profanity
            detection, see Unsupported languages in the Amazon Translate Developer Guide. If you specify multiple target languages
            for the job, all the target languages m
        Brevity:
          type: string
          enum:
          - 'ON'
          description: When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations
            (when compared with the same translation with brevity turned off). By default, brevity is turned off. If you turn
            on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity
            setting turned off. For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer
            Guide.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/translate/service/2017-07-01/translate-2017-07-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)