Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lex-models ]

get-slot-type

Description

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the lex:GetSlotType action.

See also: AWS API Documentation

Synopsis

  get-slot-type
--name <value>
--slot-type-version <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--name (string)

The name of the slot type. The name is case sensitive.

--slot-type-version (string)

The version of the slot type.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

name -> (string)

The name of the slot type.

description -> (string)

A description of the slot type.

enumerationValues -> (list)

A list of EnumerationValue objects that defines the values that the slot type can take.

(structure)

Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.

For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values

  • thick
  • thin
  • stuffed

value -> (string)

The value of the slot type.

synonyms -> (list)

Additional values related to the slot type value.

(string)

lastUpdatedDate -> (timestamp)

The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.

createdDate -> (timestamp)

The date that the slot type was created.

version -> (string)

The version of the slot type.

checksum -> (string)

Checksum of the $LATEST version of the slot type.

valueSelectionStrategy -> (string)

The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType .

parentSlotTypeSignature -> (string)

The built-in slot type used as a parent for the slot type.

slotTypeConfigurations -> (list)

Configuration information that extends the parent built-in slot type.

(structure)

Provides configuration information for a slot type.

regexConfiguration -> (structure)

A regular expression used to validate the value of a slot.

pattern -> (string)

A regular expression used to validate the value of a slot.

Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

  • A-Z, a-z
  • 0-9
  • Unicode characters ("u<Unicode>")

Represent Unicode characters with four digits, for example "u0041" or "u005A".

The following regular expression operators are not supported:

  • Infinite repeaters: *, +, or {x,} with no upper bound.
  • Wild card (.)