Translate

public struct Translate

Client object for interacting with AWS Translate service.

Provides translation between one source language and another of the same set of languages.

Member variables

Initialization

  • Initialize the Translate client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • A synchronous action that deletes a custom terminology.

    Declaration

    Swift

    @discardableResult
public func deleteTerminology(_ input: DeleteTerminologyRequest) -> EventLoopFuture<Void>

  • Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.

    Declaration

    Swift

    public func describeTextTranslationJob(_ input: DescribeTextTranslationJobRequest) -> EventLoopFuture<DescribeTextTranslationJobResponse>

  • Retrieves a custom terminology.

    Declaration

    Swift

    public func getTerminology(_ input: GetTerminologyRequest) -> EventLoopFuture<GetTerminologyResponse>

  • Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name. If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

    Declaration

    Swift

    public func importTerminology(_ input: ImportTerminologyRequest) -> EventLoopFuture<ImportTerminologyResponse>

  • Provides a list of custom terminologies associated with your account.

    Declaration

    Swift

    public func listTerminologies(_ input: ListTerminologiesRequest) -> EventLoopFuture<ListTerminologiesResponse>

  • Gets a list of the batch translation jobs that you have submitted.

    Declaration

    Swift

    public func listTextTranslationJobs(_ input: ListTextTranslationJobsRequest) -> EventLoopFuture<ListTextTranslationJobsResponse>

  • Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async. Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation. Amazon Translate does not support batch translation of multiple source languages at once.

    Declaration

    Swift

    public func startTextTranslationJob(_ input: StartTextTranslationJobRequest) -> EventLoopFuture<StartTextTranslationJobResponse>

  • Stops an asynchronous batch translation job that is in progress. If the job’s state is IN_PROGRESS, the job will be marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state. Otherwise, the job is put into the STOPPED state. Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job’s JobId.

    Declaration

    Swift

    public func stopTextTranslationJob(_ input: StopTextTranslationJobRequest) -> EventLoopFuture<StopTextTranslationJobResponse>

  • Translates input text from the source language to the target language. For a list of available languages and language codes, see what-is-languages.

    Declaration

    Swift

    public func translateText(_ input: TranslateTextRequest) -> EventLoopFuture<TranslateTextResponse>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum EncryptionKeyType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum JobStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum MergeStrategy : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TerminologyDataFormat : String, CustomStringConvertible, Codable