Amazonka.Translate.GetTerminology

Retrieves a custom terminology.

Creating a Request

data GetTerminology

See: newGetTerminology smart constructor.

Constructors

GetTerminology'

Fields

• terminologyDataFormat :: Maybe TerminologyDataFormat

  The data format of the custom terminology being retrieved.

  If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

  If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

• name :: Text

  The name of the custom terminology being retrieved.

Instances

ToJSON GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

toJSON :: GetTerminology -> Value

toEncoding :: GetTerminology -> Encoding

toJSONList :: [GetTerminology] -> Value

toEncodingList :: [GetTerminology] -> Encoding

ToHeaders GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

toHeaders :: GetTerminology -> [Header]

ToPath GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

toPath :: GetTerminology -> ByteString

ToQuery GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

toQuery :: GetTerminology -> QueryString

AWSRequest GetTerminology

Defined in Amazonka.Translate.GetTerminology

Associated Types

type AWSResponse GetTerminology

Methods

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

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

Generic GetTerminology

Defined in Amazonka.Translate.GetTerminology

Associated Types

type Rep GetTerminology :: Type -> Type

Methods

from :: GetTerminology -> Rep GetTerminology x

to :: Rep GetTerminology x -> GetTerminology

Read GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

readsPrec :: Int -> ReadS GetTerminology

readList :: ReadS [GetTerminology]

readPrec :: ReadPrec GetTerminology

readListPrec :: ReadPrec [GetTerminology]

Show GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

showsPrec :: Int -> GetTerminology -> ShowS

show :: GetTerminology -> String

showList :: [GetTerminology] -> ShowS

NFData GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

rnf :: GetTerminology -> ()

Eq GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

(==) :: GetTerminology -> GetTerminology -> Bool

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

Hashable GetTerminology

Defined in Amazonka.Translate.GetTerminology

Methods

hashWithSalt :: Int -> GetTerminology -> Int

hash :: GetTerminology -> Int

type AWSResponse GetTerminology

Defined in Amazonka.Translate.GetTerminology

type AWSResponse GetTerminology = GetTerminologyResponse

type Rep GetTerminology

Defined in Amazonka.Translate.GetTerminology

type Rep GetTerminology = D1 ('MetaData "GetTerminology" "Amazonka.Translate.GetTerminology" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "GetTerminology'" 'PrefixI 'True) (S1 ('MetaSel ('Just "terminologyDataFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TerminologyDataFormat)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetTerminology

Arguments

:: Text

GetTerminology

-> GetTerminology

Create a value of GetTerminology 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:terminologyDataFormat:GetTerminology', getTerminology_terminologyDataFormat - The data format of the custom terminology being retrieved.

If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

GetTerminology, getTerminology_name - The name of the custom terminology being retrieved.

Request Lenses

getTerminology_terminologyDataFormat :: Lens' GetTerminology (Maybe TerminologyDataFormat)

The data format of the custom terminology being retrieved.

If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

getTerminology_name :: Lens' GetTerminology Text

The name of the custom terminology being retrieved.

Destructuring the Response

data GetTerminologyResponse

See: newGetTerminologyResponse smart constructor.

Constructors

GetTerminologyResponse'

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.

• terminologyDataLocation :: Maybe TerminologyDataLocation

  The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

  Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

  CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

  Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

• terminologyProperties :: Maybe TerminologyProperties

  The properties of the custom terminology being retrieved.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetTerminologyResponse

Defined in Amazonka.Translate.GetTerminology

Associated Types

type Rep GetTerminologyResponse :: Type -> Type

Methods

from :: GetTerminologyResponse -> Rep GetTerminologyResponse x

to :: Rep GetTerminologyResponse x -> GetTerminologyResponse

Read GetTerminologyResponse

Defined in Amazonka.Translate.GetTerminology

Methods

readsPrec :: Int -> ReadS GetTerminologyResponse

readList :: ReadS [GetTerminologyResponse]

readPrec :: ReadPrec GetTerminologyResponse

readListPrec :: ReadPrec [GetTerminologyResponse]

Show GetTerminologyResponse

Defined in Amazonka.Translate.GetTerminology

Methods

showsPrec :: Int -> GetTerminologyResponse -> ShowS

show :: GetTerminologyResponse -> String

showList :: [GetTerminologyResponse] -> ShowS

NFData GetTerminologyResponse

Defined in Amazonka.Translate.GetTerminology

Methods

rnf :: GetTerminologyResponse -> ()

Eq GetTerminologyResponse

Defined in Amazonka.Translate.GetTerminology

Methods

(==) :: GetTerminologyResponse -> GetTerminologyResponse -> Bool

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

type Rep GetTerminologyResponse

Defined in Amazonka.Translate.GetTerminology

type Rep GetTerminologyResponse = D1 ('MetaData "GetTerminologyResponse" "Amazonka.Translate.GetTerminology" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "GetTerminologyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "auxiliaryDataLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TerminologyDataLocation)) :*: S1 ('MetaSel ('Just "terminologyDataLocation") '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))))

newGetTerminologyResponse

Arguments

:: Int

$sel:httpStatus:GetTerminologyResponse'

-> GetTerminologyResponse

Create a value of GetTerminologyResponse 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:GetTerminologyResponse', getTerminologyResponse_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:terminologyDataLocation:GetTerminologyResponse', getTerminologyResponse_terminologyDataLocation - The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

$sel:terminologyProperties:GetTerminologyResponse', getTerminologyResponse_terminologyProperties - The properties of the custom terminology being retrieved.

$sel:httpStatus:GetTerminologyResponse', getTerminologyResponse_httpStatus - The response's http status code.

Response Lenses

getTerminologyResponse_auxiliaryDataLocation :: Lens' GetTerminologyResponse (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.

getTerminologyResponse_terminologyDataLocation :: Lens' GetTerminologyResponse (Maybe TerminologyDataLocation)

The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

getTerminologyResponse_terminologyProperties :: Lens' GetTerminologyResponse (Maybe TerminologyProperties)

The properties of the custom terminology being retrieved.

getTerminologyResponse_httpStatus :: Lens' GetTerminologyResponse Int

The response's http status code.