[ aws . translate ]

list-terminologies

Description

Provides a list of custom terminologies associated with your account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-terminologies is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: TerminologyPropertiesList

Synopsis

  list-terminologies
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

TerminologyPropertiesList -> (list)

The properties list of the custom terminologies returned on the list request.

(structure)

The properties of the custom terminology.

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 resource. 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 this object.

Id -> (string)

The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.

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.

Directionality -> (string)

The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

UNI

The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

MULTI

Any language in the terminology resource can be the source language.

Message -> (string)

Additional information from Amazon Translate about the terminology resource.

SkippedTermCount -> (integer)

The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

Format -> (string)

The format of the custom terminology input file.

NextToken -> (string)

If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.