Amazon Translate Translate Parallel Data API

openapi: 3.1.0
info:
  title: Amazon Translate Parallel Data API
  version: '2017-07-01'
  description: Generated from AWS's published Smithy model for Amazon Translate. 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://translate.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateParallelData:
    post:
      operationId: CreateParallelData
      summary: Create Parallel Data
      description: Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel
        data files contain examples that show how you want segments of text to be translated. By adding parallel data, you
        can influence the style, tone, and word choice in your translation output.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateParallelDataResponse'
        '409':
          description: ConcurrentModificationException; ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidParameterValueException; InvalidRequestException; LimitExceededException; TooManyTagsException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '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.CreateParallelData
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateParallelDataRequest'
      tags:
      - Parallel Data
  /#DeleteParallelData:
    post:
      operationId: DeleteParallelData
      summary: Delete Parallel Data
      description: Deletes a parallel data resource in Amazon Translate.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteParallelDataResponse'
        '409':
          description: ConcurrentModificationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '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: 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.DeleteParallelData
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteParallelDataRequest'
      tags:
      - Parallel Data
  /#GetParallelData:
    post:
      operationId: GetParallelData
      summary: Get Parallel Data
      description: Provides information about a parallel data resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetParallelDataResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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.GetParallelData
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetParallelDataRequest'
      tags:
      - Parallel Data
  /#ListParallelData:
    post:
      operationId: ListParallelData
      summary: List Parallel Data
      description: Provides a list of your parallel data resources in Amazon Translate.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListParallelDataResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '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.ListParallelData
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListParallelDataRequest'
      tags:
      - Parallel Data
  /#UpdateParallelData:
    post:
      operationId: UpdateParallelData
      summary: Update Parallel Data
      description: Updates a previously created parallel data resource by importing a new input file from Amazon S3.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateParallelDataResponse'
        '409':
          description: ConcurrentModificationException; ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConcurrentModificationException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidParameterValueException; InvalidRequestException; LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '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.UpdateParallelData
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateParallelDataRequest'
      tags:
      - Parallel Data
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:
    ConcurrentModificationException:
      type: object
      properties:
        Message:
          type: string
    CreateParallelDataRequest:
      type: object
      properties:
        Name:
          type: string
          description: A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique
            in the account and region.
        Description:
          type: string
          description: A custom description for the parallel data resource in Amazon Translate.
        ParallelDataConfig:
          $ref: '#/components/schemas/ParallelDataConfig'
        EncryptionKey:
          $ref: '#/components/schemas/EncryptionKey'
        ClientToken:
          type: string
          description: A unique identifier for the request. This token is automatically generated when you use Amazon Translate
            through an AWS SDK.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource.
            Each tag key for the resource must be unique. For more information, see Tagging your resources.
      required:
      - Name
      - ParallelDataConfig
      - ClientToken
    CreateParallelDataResponse:
      type: object
      properties:
        Name:
          type: string
          description: The custom name that you assigned to the parallel data resource.
        Status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The status of the parallel data resource. When the resource is ready for you to use, the status is
            ACTIVE.
    DeleteParallelDataRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the parallel data resource that is being deleted.
      required:
      - Name
    DeleteParallelDataResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the parallel data resource that is being deleted.
        Status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The status of the parallel data deletion.
    EncryptionKey:
      type: object
      properties:
        Type:
          type: string
          enum:
          - KMS
          description: The type of encryption key used by Amazon Translate to encrypt this object.
        Id:
          type: string
          description: The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
      required:
      - Type
      - Id
    GetParallelDataRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the parallel data resource that is being retrieved.
      required:
      - Name
    GetParallelDataResponse:
      type: object
      properties:
        ParallelDataProperties:
          $ref: '#/components/schemas/ParallelDataProperties'
        DataLocation:
          $ref: '#/components/schemas/ParallelDataDataLocation'
        AuxiliaryDataLocation:
          $ref: '#/components/schemas/ParallelDataDataLocation'
        LatestUpdateAttemptAuxiliaryDataLocation:
          $ref: '#/components/schemas/ParallelDataDataLocation'
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    InvalidParameterValueException:
      type: object
      properties:
        Message:
          type: string
    ListParallelDataRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: A string that specifies the next page of results to return in a paginated response.
        MaxResults:
          type: integer
          description: The maximum number of parallel data resources returned for each request.
    ListParallelDataResponse:
      type: object
      properties:
        ParallelDataPropertiesList:
          type: array
          items:
            $ref: '#/components/schemas/ParallelDataProperties'
          description: The properties of the parallel data resources returned by this request.
        NextToken:
          type: string
          description: The string to use in a subsequent request to get the next page of results in a paginated response.
            This value is null if there are no additional pages.
    ParallelDataConfig:
      type: object
      properties:
        S3Uri:
          type: string
          description: The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the
            same Region as the API endpoint you are calling.
        Format:
          type: string
          enum:
          - TSV
          - CSV
          - TMX
          description: The format of the parallel data input file.
    ParallelDataDataLocation:
      type: object
      properties:
        RepositoryType:
          type: string
          description: Describes the repository that contains the parallel data input file.
        Location:
          type: string
          description: The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL
            to that has a 30-minute expiration. Amazon Translate doesn't scan all input files for the risk of CSV injection
            attacks. CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The
            record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program,
            the program might interpret the record as a formula and run the code within it. Before you download an input file
            from Amazon S3, ensure that you recognize the fil
      required:
      - RepositoryType
      - Location
    ParallelDataProperties:
      type: object
      properties:
        Name:
          type: string
          description: The custom name assigned to the parallel data resource.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the parallel data resource.
        Description:
          type: string
          description: The description assigned to the parallel data resource.
        Status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The status of the parallel data resource. When the parallel data is ready for you to use, the status
            is ACTIVE.
        SourceLanguageCode:
          type: string
          description: The source language of the translations in the parallel data file.
        TargetLanguageCodes:
          type: array
          items:
            type: string
          description: The language codes for the target languages available in the parallel data file. All possible target
            languages are returned as an array.
        ParallelDataConfig:
          $ref: '#/components/schemas/ParallelDataConfig'
        Message:
          type: string
          description: Additional information from Amazon Translate about the parallel data resource.
        ImportedDataSize:
          type: integer
          description: The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This
            number includes only the characters in your translation examples. It does not include characters that are used
            to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does
            not include the tags.
        ImportedRecordCount:
          type: integer
          description: The number of records successfully imported from the parallel data input file.
        FailedRecordCount:
          type: integer
          description: The number of records unsuccessfully imported from the parallel data input file.
        SkippedRecordCount:
          type: integer
          description: The number of items in the input file that Amazon Translate skipped when you created or updated the
            parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.
        EncryptionKey:
          $ref: '#/components/schemas/EncryptionKey'
        CreatedAt:
          type: string
          format: date-time
          description: The time at which the parallel data resource was created.
        LastUpdatedAt:
          type: string
          format: date-time
          description: The time at which the parallel data resource was last updated.
        LatestUpdateAttemptStatus:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The status of the most recent update attempt for the parallel data resource.
        LatestUpdateAttemptAt:
          type: string
          format: date-time
          description: The time that the most recent update was attempted.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The initial part of a key-value pair that forms a tag associated with a given resource.
        Value:
          type: string
          description: The second part of a key-value pair that forms a tag associated with a given resource.
      required:
      - Key
      - Value
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
    UpdateParallelDataRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the parallel data resource being updated.
        Description:
          type: string
          description: A custom description for the parallel data resource in Amazon Translate.
        ParallelDataConfig:
          $ref: '#/components/schemas/ParallelDataConfig'
        ClientToken:
          type: string
          description: A unique identifier for the request. This token is automatically generated when you use Amazon Translate
            through an AWS SDK.
      required:
      - Name
      - ParallelDataConfig
      - ClientToken
    UpdateParallelDataResponse:
      type: object
      properties:
        Name:
          type: string
          description: The name of the parallel data resource being updated.
        Status:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The status of the parallel data resource that you are attempting to update. Your update request is
            accepted only if this status is either ACTIVE or FAILED.
        LatestUpdateAttemptStatus:
          type: string
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - FAILED
          description: The status of the parallel data update attempt. When the updated parallel data resource is ready for
            you to use, the status is ACTIVE.
        LatestUpdateAttemptAt:
          type: string
          format: date-time
          description: The time that the most recent update was attempted.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/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)