Amazonka.Translate.ImportTerminology

Creates or updates a custom terminology, depending on whether 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. The only supported merge strategy is OVERWRITE, where the imported terminology overwrites the existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology takes up to 10 minutes to fully propagate. After that, translations have access to the new terminology.

Creating a Request

data ImportTerminology

See: newImportTerminology smart constructor.

Constructors

ImportTerminology'

Fields

• description :: Maybe Text

  The description of the custom terminology being imported.

• encryptionKey :: Maybe EncryptionKey

  The encryption key for the custom terminology being imported.

• 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

  The name of the custom terminology being imported.

• mergeStrategy :: MergeStrategy

  The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

• terminologyData :: TerminologyData

  The terminology data for the custom terminology being imported.

Instances

ToJSON ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

toJSON :: ImportTerminology -> Value

toEncoding :: ImportTerminology -> Encoding

toJSONList :: [ImportTerminology] -> Value

toEncodingList :: [ImportTerminology] -> Encoding

ToHeaders ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

toHeaders :: ImportTerminology -> [Header]

ToPath ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

toPath :: ImportTerminology -> ByteString

ToQuery ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

toQuery :: ImportTerminology -> QueryString

AWSRequest ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Associated Types

type AWSResponse ImportTerminology

Methods

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

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

Generic ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Associated Types

type Rep ImportTerminology :: Type -> Type

Methods

from :: ImportTerminology -> Rep ImportTerminology x

to :: Rep ImportTerminology x -> ImportTerminology

Show ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

showsPrec :: Int -> ImportTerminology -> ShowS

show :: ImportTerminology -> String

showList :: [ImportTerminology] -> ShowS

NFData ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

rnf :: ImportTerminology -> ()

Eq ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

(==) :: ImportTerminology -> ImportTerminology -> Bool

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

Hashable ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

Methods

hashWithSalt :: Int -> ImportTerminology -> Int

hash :: ImportTerminology -> Int

type AWSResponse ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

type AWSResponse ImportTerminology = ImportTerminologyResponse

type Rep ImportTerminology

Defined in Amazonka.Translate.ImportTerminology

type Rep ImportTerminology = D1 ('MetaData "ImportTerminology" "Amazonka.Translate.ImportTerminology" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "ImportTerminology'" '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 "mergeStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MergeStrategy) :*: S1 ('MetaSel ('Just "terminologyData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TerminologyData)))))

newImportTerminology

Arguments

:: Text

ImportTerminology

-> MergeStrategy

$sel:mergeStrategy:ImportTerminology'

-> TerminologyData

$sel:terminologyData:ImportTerminology'

-> ImportTerminology

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

ImportTerminology, importTerminology_description - The description of the custom terminology being imported.

ImportTerminology, importTerminology_encryptionKey - The encryption key for the custom terminology being imported.

$sel:tags:ImportTerminology', importTerminology_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.

ImportTerminology, importTerminology_name - The name of the custom terminology being imported.

$sel:mergeStrategy:ImportTerminology', importTerminology_mergeStrategy - The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

$sel:terminologyData:ImportTerminology', importTerminology_terminologyData - The terminology data for the custom terminology being imported.

Request Lenses

importTerminology_description :: Lens' ImportTerminology (Maybe Text)

The description of the custom terminology being imported.

importTerminology_encryptionKey :: Lens' ImportTerminology (Maybe EncryptionKey)

The encryption key for the custom terminology being imported.

importTerminology_tags :: Lens' ImportTerminology (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.

importTerminology_name :: Lens' ImportTerminology Text

The name of the custom terminology being imported.

importTerminology_mergeStrategy :: Lens' ImportTerminology MergeStrategy

The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

importTerminology_terminologyData :: Lens' ImportTerminology TerminologyData

The terminology data for the custom terminology being imported.

Destructuring the Response

data ImportTerminologyResponse

See: newImportTerminologyResponse smart constructor.

Constructors

ImportTerminologyResponse'

Fields

• auxiliaryDataLocation :: Maybe TerminologyDataLocation

  The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.

• terminologyProperties :: Maybe TerminologyProperties

  The properties of the custom terminology being imported.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ImportTerminologyResponse

Defined in Amazonka.Translate.ImportTerminology

Associated Types

type Rep ImportTerminologyResponse :: Type -> Type

Methods

from :: ImportTerminologyResponse -> Rep ImportTerminologyResponse x

to :: Rep ImportTerminologyResponse x -> ImportTerminologyResponse

Read ImportTerminologyResponse

Defined in Amazonka.Translate.ImportTerminology

Methods

readsPrec :: Int -> ReadS ImportTerminologyResponse

readList :: ReadS [ImportTerminologyResponse]

readPrec :: ReadPrec ImportTerminologyResponse

readListPrec :: ReadPrec [ImportTerminologyResponse]

Show ImportTerminologyResponse

Defined in Amazonka.Translate.ImportTerminology

Methods

showsPrec :: Int -> ImportTerminologyResponse -> ShowS

show :: ImportTerminologyResponse -> String

showList :: [ImportTerminologyResponse] -> ShowS

NFData ImportTerminologyResponse

Defined in Amazonka.Translate.ImportTerminology

Methods

rnf :: ImportTerminologyResponse -> ()

Eq ImportTerminologyResponse

Defined in Amazonka.Translate.ImportTerminology

Methods

(==) :: ImportTerminologyResponse -> ImportTerminologyResponse -> Bool

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

type Rep ImportTerminologyResponse

Defined in Amazonka.Translate.ImportTerminology

type Rep ImportTerminologyResponse = D1 ('MetaData "ImportTerminologyResponse" "Amazonka.Translate.ImportTerminology" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "ImportTerminologyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "auxiliaryDataLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TerminologyDataLocation)) :*: (S1 ('MetaSel ('Just "terminologyProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TerminologyProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newImportTerminologyResponse

Arguments

:: Int

$sel:httpStatus:ImportTerminologyResponse'

-> ImportTerminologyResponse

Create a value of ImportTerminologyResponse 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:auxiliaryDataLocation:ImportTerminologyResponse', importTerminologyResponse_auxiliaryDataLocation - The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.

$sel:terminologyProperties:ImportTerminologyResponse', importTerminologyResponse_terminologyProperties - The properties of the custom terminology being imported.

$sel:httpStatus:ImportTerminologyResponse', importTerminologyResponse_httpStatus - The response's http status code.

Response Lenses

importTerminologyResponse_auxiliaryDataLocation :: Lens' ImportTerminologyResponse (Maybe TerminologyDataLocation)

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.

importTerminologyResponse_terminologyProperties :: Lens' ImportTerminologyResponse (Maybe TerminologyProperties)

The properties of the custom terminology being imported.

importTerminologyResponse_httpStatus :: Lens' ImportTerminologyResponse Int

The response's http status code.