amazonka-translate-2.0: Amazon Translate SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Translate.CreateParallelData

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.

Synopsis

Creating a Request

data CreateParallelData Source #

See: newCreateParallelData smart constructor.

Constructors

CreateParallelData' 

Fields

  • description :: Maybe Text

    A custom description for the parallel data resource in Amazon Translate.

  • encryptionKey :: Maybe EncryptionKey
     
  • tags :: Maybe [Tag]

    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.

  • name :: Text

    A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

  • parallelDataConfig :: ParallelDataConfig

    Specifies the format and S3 location of the parallel data input file.

  • clientToken :: Text

    A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

Instances

Instances details
ToJSON CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

ToHeaders CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

ToPath CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

ToQuery CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

AWSRequest CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Associated Types

type AWSResponse CreateParallelData #

Generic CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Associated Types

type Rep CreateParallelData :: Type -> Type #

Read CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Show CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

NFData CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Methods

rnf :: CreateParallelData -> () #

Eq CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Hashable CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

type AWSResponse CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

type Rep CreateParallelData Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

type Rep CreateParallelData = D1 ('MetaData "CreateParallelData" "Amazonka.Translate.CreateParallelData" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "CreateParallelData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionKey)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "parallelDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ParallelDataConfig) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateParallelData Source #

Create a value of CreateParallelData 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:

CreateParallelData, createParallelData_description - A custom description for the parallel data resource in Amazon Translate.

CreateParallelData, createParallelData_encryptionKey - Undocumented member.

$sel:tags:CreateParallelData', createParallelData_tags - 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.

CreateParallelData, createParallelData_name - A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

CreateParallelData, createParallelData_parallelDataConfig - Specifies the format and S3 location of the parallel data input file.

$sel:clientToken:CreateParallelData', createParallelData_clientToken - A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

Request Lenses

createParallelData_description :: Lens' CreateParallelData (Maybe Text) Source #

A custom description for the parallel data resource in Amazon Translate.

createParallelData_tags :: Lens' CreateParallelData (Maybe [Tag]) Source #

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.

createParallelData_name :: Lens' CreateParallelData Text Source #

A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

createParallelData_parallelDataConfig :: Lens' CreateParallelData ParallelDataConfig Source #

Specifies the format and S3 location of the parallel data input file.

createParallelData_clientToken :: Lens' CreateParallelData Text Source #

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

Destructuring the Response

data CreateParallelDataResponse Source #

See: newCreateParallelDataResponse smart constructor.

Constructors

CreateParallelDataResponse' 

Fields

Instances

Instances details
Generic CreateParallelDataResponse Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Associated Types

type Rep CreateParallelDataResponse :: Type -> Type #

Read CreateParallelDataResponse Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Show CreateParallelDataResponse Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

NFData CreateParallelDataResponse Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

Eq CreateParallelDataResponse Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

type Rep CreateParallelDataResponse Source # 
Instance details

Defined in Amazonka.Translate.CreateParallelData

type Rep CreateParallelDataResponse = D1 ('MetaData "CreateParallelDataResponse" "Amazonka.Translate.CreateParallelData" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "CreateParallelDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParallelDataStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateParallelDataResponse Source #

Create a value of CreateParallelDataResponse 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:

CreateParallelData, createParallelDataResponse_name - The custom name that you assigned to the parallel data resource.

CreateParallelDataResponse, createParallelDataResponse_status - The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.

$sel:httpStatus:CreateParallelDataResponse', createParallelDataResponse_httpStatus - The response's http status code.

Response Lenses

createParallelDataResponse_name :: Lens' CreateParallelDataResponse (Maybe Text) Source #

The custom name that you assigned to the parallel data resource.

createParallelDataResponse_status :: Lens' CreateParallelDataResponse (Maybe ParallelDataStatus) Source #

The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.