get-terminology¶
Description¶
Retrieves a custom terminology.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-terminology
--name <value>
--terminology-data-format <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--name (string)
The name of the custom terminology being retrieved.
--terminology-data-format (string)
The data format of the custom terminology being retrieved, either CSV or TMX.
Possible values:
CSV
TMX
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
TerminologyProperties -> (structure)
The properties of the custom terminology being retrieved.
Name -> (string)
The name of the custom terminology.
Description -> (string)
The description of the custom terminology properties.
Arn -> (string)
The Amazon Resource Name (ARN) of the custom terminology.
SourceLanguageCode -> (string)
The language code for the source text of the translation request for which the custom terminology is being used.
TargetLanguageCodes -> (list)
The language codes for the target languages available with the custom terminology file. All possible target languages are returned in array.
(string)
EncryptionKey -> (structure)
The encryption key for the custom terminology.
Type -> (string)
The type of encryption key used by Amazon Translate to encrypt custom terminologies.
Id -> (string)
The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
SizeBytes -> (integer)
The size of the file used when importing a custom terminology.
TermCount -> (integer)
The number of terms included in the custom terminology.
CreatedAt -> (timestamp)
The time at which the custom terminology was created, based on the timestamp.
LastUpdatedAt -> (timestamp)
The time at which the custom terminology was last update, based on the timestamp.
TerminologyDataLocation -> (structure)
The data location of the custom terminology being retrieved. The custom terminology file is returned in a presigned url that has a 30 minute expiration.
RepositoryType -> (string)
The repository type for the custom terminology data.
Location -> (string)
The location of the custom terminology data.