Amazonka.Translate.TranslateText

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

Creating a Request

data TranslateText

See: newTranslateText smart constructor.

Constructors

TranslateText'

Fields

• settings :: Maybe TranslationSettings

  Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

• terminologyNames :: Maybe [Text]

  The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

• text :: Text

  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.

• sourceLanguageCode :: Text

  The language code for the language of the source text. The language must be a language supported by Amazon Translate. 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 :: Text

  The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

Instances

ToJSON TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

toJSON :: TranslateText -> Value

toEncoding :: TranslateText -> Encoding

toJSONList :: [TranslateText] -> Value

toEncodingList :: [TranslateText] -> Encoding

ToHeaders TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

toHeaders :: TranslateText -> [Header]

ToPath TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

toPath :: TranslateText -> ByteString

ToQuery TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

toQuery :: TranslateText -> QueryString

AWSRequest TranslateText

Defined in Amazonka.Translate.TranslateText

Associated Types

type AWSResponse TranslateText

Methods

request :: (Service -> Service) -> TranslateText -> Request TranslateText

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TranslateText -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TranslateText)))

Generic TranslateText

Defined in Amazonka.Translate.TranslateText

Associated Types

type Rep TranslateText :: Type -> Type

Methods

from :: TranslateText -> Rep TranslateText x

to :: Rep TranslateText x -> TranslateText

Read TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

readsPrec :: Int -> ReadS TranslateText

readList :: ReadS [TranslateText]

readPrec :: ReadPrec TranslateText

readListPrec :: ReadPrec [TranslateText]

Show TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

showsPrec :: Int -> TranslateText -> ShowS

show :: TranslateText -> String

showList :: [TranslateText] -> ShowS

NFData TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

rnf :: TranslateText -> ()

Eq TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

(==) :: TranslateText -> TranslateText -> Bool

(/=) :: TranslateText -> TranslateText -> Bool

Hashable TranslateText

Defined in Amazonka.Translate.TranslateText

Methods

hashWithSalt :: Int -> TranslateText -> Int

hash :: TranslateText -> Int

type AWSResponse TranslateText

Defined in Amazonka.Translate.TranslateText

type AWSResponse TranslateText = TranslateTextResponse

type Rep TranslateText

Defined in Amazonka.Translate.TranslateText

type Rep TranslateText = D1 ('MetaData "TranslateText" "Amazonka.Translate.TranslateText" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "TranslateText'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranslationSettings)) :*: S1 ('MetaSel ('Just "terminologyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sourceLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTranslateText

Arguments

:: Text

$sel:text:TranslateText'

-> Text

TranslateText

-> Text

TranslateText

-> TranslateText

Create a value of TranslateText with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TranslateText, translateText_settings - Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

TranslateText, translateText_terminologyNames - The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

$sel:text:TranslateText', translateText_text - 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.

TranslateText, translateText_sourceLanguageCode - The language code for the language of the source text. The language must be a language supported by Amazon Translate. 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.

TranslateText, translateText_targetLanguageCode - The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

Request Lenses

translateText_settings :: Lens' TranslateText (Maybe TranslationSettings)

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

translateText_terminologyNames :: Lens' TranslateText (Maybe [Text])

The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

translateText_text :: Lens' TranslateText Text

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.

translateText_sourceLanguageCode :: Lens' TranslateText Text

The language code for the language of the source text. The language must be a language supported by Amazon Translate. 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.

translateText_targetLanguageCode :: Lens' TranslateText Text

The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

Destructuring the Response

data TranslateTextResponse

See: newTranslateTextResponse smart constructor.

Constructors

TranslateTextResponse'

Fields

• appliedSettings :: Maybe TranslationSettings

  Settings that configure the translation output.

• appliedTerminologies :: Maybe [AppliedTerminology]

  The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

• httpStatus :: Int

  The response's http status code.

• translatedText :: Text

  The translated text.

• sourceLanguageCode :: Text

  The language code for the language of the source text.

• targetLanguageCode :: Text

  The language code for the language of the target text.

Instances

Generic TranslateTextResponse

Defined in Amazonka.Translate.TranslateText

Associated Types

type Rep TranslateTextResponse :: Type -> Type

Methods

from :: TranslateTextResponse -> Rep TranslateTextResponse x

to :: Rep TranslateTextResponse x -> TranslateTextResponse

Read TranslateTextResponse

Defined in Amazonka.Translate.TranslateText

Methods

readsPrec :: Int -> ReadS TranslateTextResponse

readList :: ReadS [TranslateTextResponse]

readPrec :: ReadPrec TranslateTextResponse

readListPrec :: ReadPrec [TranslateTextResponse]

Show TranslateTextResponse

Defined in Amazonka.Translate.TranslateText

Methods

showsPrec :: Int -> TranslateTextResponse -> ShowS

show :: TranslateTextResponse -> String

showList :: [TranslateTextResponse] -> ShowS

NFData TranslateTextResponse

Defined in Amazonka.Translate.TranslateText

Methods

rnf :: TranslateTextResponse -> ()

Eq TranslateTextResponse

Defined in Amazonka.Translate.TranslateText

Methods

(==) :: TranslateTextResponse -> TranslateTextResponse -> Bool

(/=) :: TranslateTextResponse -> TranslateTextResponse -> Bool

type Rep TranslateTextResponse

Defined in Amazonka.Translate.TranslateText

type Rep TranslateTextResponse = D1 ('MetaData "TranslateTextResponse" "Amazonka.Translate.TranslateText" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "TranslateTextResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "appliedSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranslationSettings)) :*: (S1 ('MetaSel ('Just "appliedTerminologies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AppliedTerminology])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :*: (S1 ('MetaSel ('Just "translatedText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sourceLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTranslateTextResponse

Arguments

:: Int

$sel:httpStatus:TranslateTextResponse'

-> Text

$sel:translatedText:TranslateTextResponse'

-> Text

TranslateText

-> Text

TranslateText

-> TranslateTextResponse

Create a value of TranslateTextResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:appliedSettings:TranslateTextResponse', translateTextResponse_appliedSettings - Settings that configure the translation output.

$sel:appliedTerminologies:TranslateTextResponse', translateTextResponse_appliedTerminologies - The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

$sel:httpStatus:TranslateTextResponse', translateTextResponse_httpStatus - The response's http status code.

$sel:translatedText:TranslateTextResponse', translateTextResponse_translatedText - The translated text.

TranslateText, translateTextResponse_sourceLanguageCode - The language code for the language of the source text.

TranslateText, translateTextResponse_targetLanguageCode - The language code for the language of the target text.

Response Lenses

translateTextResponse_appliedSettings :: Lens' TranslateTextResponse (Maybe TranslationSettings)

Settings that configure the translation output.

translateTextResponse_appliedTerminologies :: Lens' TranslateTextResponse (Maybe [AppliedTerminology])

The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

translateTextResponse_httpStatus :: Lens' TranslateTextResponse Int

The response's http status code.

translateTextResponse_translatedText :: Lens' TranslateTextResponse Text

The translated text.

translateTextResponse_sourceLanguageCode :: Lens' TranslateTextResponse Text

The language code for the language of the source text.

translateTextResponse_targetLanguageCode :: Lens' TranslateTextResponse Text

The language code for the language of the target text.