Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Translate.Types.InputDataConfig

Description

Synopsis

data InputDataConfig = InputDataConfig' {
- s3Uri :: Text
- contentType :: Text
}
newInputDataConfig :: Text -> Text -> InputDataConfig
inputDataConfig_s3Uri :: Lens' InputDataConfig Text
inputDataConfig_contentType :: Lens' InputDataConfig Text

Documentation

data InputDataConfig Source #

The input configuration properties for requesting a batch translation job.

See: newInputDataConfig smart constructor.

Constructors

InputDataConfig'

Fields

s3Uri :: Text
The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.
contentType :: Text
Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
- text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
- text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
- application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx).
- application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx).
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx).
If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.

Instances

Instances details

Eq InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Methods (==) :: InputDataConfig -> InputDataConfig -> Bool # (/=) :: InputDataConfig -> InputDataConfig -> Bool #
Read InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Methods readsPrec :: Int -> ReadS InputDataConfig # readList :: ReadS [InputDataConfig] # readPrec :: ReadPrec InputDataConfig # readListPrec :: ReadPrec [InputDataConfig] #
Show InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Methods showsPrec :: Int -> InputDataConfig -> ShowS # show :: InputDataConfig -> String # showList :: [InputDataConfig] -> ShowS #
Generic InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Associated Types type Rep InputDataConfig :: Type -> Type # Methods from :: InputDataConfig -> Rep InputDataConfig x # to :: Rep InputDataConfig x -> InputDataConfig #
NFData InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Methods rnf :: InputDataConfig -> () #
Hashable InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Methods hashWithSalt :: Int -> InputDataConfig -> Int # hash :: InputDataConfig -> Int #
ToJSON InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Methods toJSON :: InputDataConfig -> Value # toEncoding :: InputDataConfig -> Encoding # toJSONList :: [InputDataConfig] -> Value # toEncodingList :: [InputDataConfig] -> Encoding #
FromJSON InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig Methods parseJSON :: Value -> Parser InputDataConfig # parseJSONList :: Value -> Parser [InputDataConfig] #
type Rep InputDataConfig Source #
Instance details Defined in Amazonka.Translate.Types.InputDataConfig type Rep InputDataConfig = D1 ('MetaData "InputDataConfig" "Amazonka.Translate.Types.InputDataConfig" "libZSservicesZSamazonka-translateZSamazonka-translate" 'False) (C1 ('MetaCons "InputDataConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newInputDataConfig Source #

Arguments

:: Text	`$sel:s3Uri:InputDataConfig'`
-> Text	`$sel:contentType:InputDataConfig'`
-> InputDataConfig

Create a value of InputDataConfig 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:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.

$sel:contentType:InputDataConfig', inputDataConfig_contentType - Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:

text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx).
application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx).
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx).

If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.

inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #

The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.

inputDataConfig_contentType :: Lens' InputDataConfig Text Source #

Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:

text/html: The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
text/plain: The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
application/vnd.openxmlformats-officedocument.wordprocessingml.document: The input data consists of one or more Word documents (.docx).
application/vnd.openxmlformats-officedocument.presentationml.presentation: The input data consists of one or more PowerPoint Presentation files (.pptx).
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: The input data consists of one or more Excel Workbook files (.xlsx).

If you structure your input data as HTML, ensure that you set this parameter to text/html. By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain, your costs will cover the translation of every character.