Amazon Polly Lexicons API

openapi: 3.1.0
info:
  title: Amazon Polly Lexicons API
  version: '2016-06-10'
  description: Generated from AWS's published Smithy model for Amazon Polly. 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://polly.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /v1/lexicons/{Name}:
    delete:
      operationId: DeleteLexicon
      summary: Delete Lexicon
      description: Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has
        been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon
        or ListLexicon APIs. For more information, see Managing Lexicons.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLexiconOutput'
              example: {}
        '404':
          description: LexiconNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LexiconNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteLexiconInput'
            example:
              Name: example
      tags:
      - Lexicons
    get:
      operationId: GetLexicon
      summary: Get Lexicon
      description: Returns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For
        more information, see Managing Lexicons.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLexiconOutput'
        '404':
          description: LexiconNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LexiconNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetLexiconInput'
      tags:
      - Lexicons
    put:
      operationId: PutLexicon
      summary: Put Lexicon
      description: Stores a pronunciation lexicon in an Amazon Web Services Region. If a lexicon with the same name already
        exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore,
        it might take some time before the lexicon is available to the SynthesizeSpeech operation. Overwriting a lexicon keeps
        its existing tags. You can specify tags only when you create a lexicon. If you specify tags for a lexicon that already
        exists, the request fails with a ValidationException. To change the tags of an existing lexicon, use TagResource and
        UntagResource. For more information, see Managing Lexicons.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutLexiconOutput'
              example: {}
        '400':
          description: InvalidLexiconException; InvalidTagParameterException; LexiconSizeExceededException; MaxLexemeLengthExceededException;
            MaxLexiconsNumberExceededException; TooManyTagsException; UnsupportedPlsAlphabetException; UnsupportedPlsLanguageException;
            ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLexiconException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutLexiconInput'
            example:
              Name: W3C
              Content: <Lexicon Content>
      tags:
      - Lexicons
  /v1/lexicons:
    get:
      operationId: ListLexicons
      summary: List Lexicons
      description: Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information,
        see Managing Lexicons.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLexiconsOutput'
              example:
                Lexicons:
                - Attributes:
                    LanguageCode: en-US
                    LastModified: 1478542980.117
                    Alphabet: ipa
                    LexemesCount: 1
                    LexiconArn: arn:aws:polly:us-east-1:123456789012:lexicon/example
                    Size: 503
                  Name: example
        '400':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFailureException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLexiconsInput'
      tags:
      - Lexicons
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: polly
  schemas:
    DeleteLexiconInput:
      type: object
      properties:
        Name:
          type: string
          description: The name of the lexicon to delete. Must be an existing lexicon in the region.
      required:
      - Name
    DeleteLexiconOutput:
      type: object
      properties: {}
    GetLexiconInput:
      type: object
      properties:
        Name:
          type: string
          description: Name of the lexicon.
      required:
      - Name
    GetLexiconOutput:
      type: object
      properties:
        Lexicon:
          $ref: '#/components/schemas/Lexicon'
        LexiconAttributes:
          $ref: '#/components/schemas/LexiconAttributes'
    InvalidLexiconException:
      type: object
      properties:
        message:
          type: string
    InvalidNextTokenException:
      type: object
      properties:
        message:
          type: string
    Lexicon:
      type: object
      properties:
        Content:
          type: string
          description: Lexicon content in string format. The content of a lexicon must be in PLS format.
        Name:
          type: string
          description: Name of the lexicon.
    LexiconAttributes:
      type: object
      properties:
        Alphabet:
          type: string
          description: Phonetic alphabet used in the lexicon. Valid values are ipa, x-sampa, x-amazon-pinyin, x-amazon-jyutping,
            x-amazon-pron-kana, and x-amazon-yomigana.
        LanguageCode:
          type: string
          enum:
          - arb
          - cmn-CN
          - cy-GB
          - da-DK
          - de-DE
          - en-AU
          - en-GB
          - en-GB-WLS
          - en-IN
          - en-US
          - es-ES
          - es-MX
          - es-US
          - fr-CA
          - fr-FR
          - is-IS
          - it-IT
          - ja-JP
          - hi-IN
          - ko-KR
          - nb-NO
          - nl-NL
          - pl-PL
          - pt-BR
          - pt-PT
          - ro-RO
          - ru-RU
          - sv-SE
          - tr-TR
          - en-NZ
          - en-ZA
          - ca-ES
          - de-AT
          - yue-CN
          - ar-AE
          - fi-FI
          - en-IE
          - nl-BE
          - fr-BE
          - cs-CZ
          - de-CH
          - en-SG
          description: Language code that the lexicon applies to. A lexicon with a language code such as "en" would be applied
            to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.
        LastModified:
          type: string
          format: date-time
          description: Date lexicon was last modified (a timestamp value).
        LexiconArn:
          type: string
          description: Amazon Resource Name (ARN) of the lexicon.
        LexemesCount:
          type: integer
          description: Number of lexemes in the lexicon.
        Size:
          type: integer
          description: Total size of the lexicon, in characters.
    LexiconDescription:
      type: object
      properties:
        Name:
          type: string
          description: Name of the lexicon.
        Attributes:
          $ref: '#/components/schemas/LexiconAttributes'
    LexiconNotFoundException:
      type: object
      properties:
        message:
          type: string
    ListLexiconsInput:
      type: object
      properties:
        NextToken:
          type: string
          description: An opaque pagination token returned from previous ListLexicons operation. If present, indicates where
            to continue the list of lexicons.
    ListLexiconsOutput:
      type: object
      properties:
        Lexicons:
          type: array
          items:
            $ref: '#/components/schemas/LexiconDescription'
          description: A list of lexicon names and attributes.
        NextToken:
          type: string
          description: The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned
            only if the response is truncated.
    PutLexiconInput:
      type: object
      properties:
        Name:
          type: string
          description: Name of the lexicon. The name must follow the regular expression format [0-9A-Za-z]{1,20}. That is,
            the name is a case-sensitive alphanumeric string up to 20 characters long.
        Content:
          type: string
          description: Content of the PLS lexicon as string data.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: The metadata that you apply to the lexicon to help you categorize and organize it. Each tag consists
            of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128
            characters, and tag values can have a maximum length of 256 characters. You can't replace the tags of an existing
            lexicon by overwriting it with PutLexicon.
      required:
      - Name
      - Content
    PutLexiconOutput:
      type: object
      properties: {}
    ServiceFailureException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/polly/service/2016-06-10/polly-2016-06-10.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)