AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Lex Model Building V2 CreateSlotType API operation.

Syntax

New-LMBV2SlotType
-SlotTypeName <String>
-AdvancedRecognitionSetting_AudioRecognitionStrategy <AudioRecognitionStrategy>
-BotId <String>
-BotVersion <String>
-Description <String>
-Source_KmsKeyArn <String>
-LocaleId <String>
-ParentSlotTypeSignature <String>
-RegexFilter_Pattern <String>
-ValueSelectionSetting_ResolutionStrategy <SlotValueResolutionStrategy>
-Source_S3BucketName <String>
-Source_S3ObjectKey <String>
-SlotTypeValue <SlotTypeValue[]>
-CompositeSlotTypeSetting_SubSlot <SubSlotTypeComposition[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLexModelsV2Config>

Description

Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

Parameters

-AdvancedRecognitionSetting_AudioRecognitionStrategy <AudioRecognitionStrategy>
Enables using the slot values as a custom vocabulary for recognizing user utterances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesValueSelectionSetting_AdvancedRecognitionSetting_AudioRecognitionStrategy
-BotId <String>
The identifier of the bot associated with this slot type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BotVersion <String>
The identifier of the bot version associated with this slot type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonLexModelsV2Config>
Amazon.PowerShell.Cmdlets.LMBV2.AmazonLexModelsV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CompositeSlotTypeSetting_SubSlot <SubSlotTypeComposition[]>
Subslots in the composite slot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCompositeSlotTypeSetting_SubSlots
-Description <String>
A description of the slot type. Use the description to help identify the slot type in lists.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocaleId <String>
The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParentSlotTypeSignature <String>
The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.Only AMAZON.AlphaNumeric is supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the SlotTypeName parameter. The -PassThru parameter is deprecated, use -Select '^SlotTypeName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RegexFilter_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 (.)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesValueSelectionSetting_RegexFilter_Pattern
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LexModelsV2.Model.CreateSlotTypeResponse). Specifying the name of a property of type Amazon.LexModelsV2.Model.CreateSlotTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SlotTypeName <String>
The name for the slot. A slot type name must be unique within the account.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-SlotTypeValue <SlotTypeValue[]>
A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSlotTypeValues
-Source_KmsKeyArn <String>
The Amazon KMS key required to decrypt the contents of the grammar, if any.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExternalSourceSetting_GrammarSlotTypeSetting_Source_KmsKeyArn
-Source_S3BucketName <String>
The name of the S3 bucket that contains the grammar source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExternalSourceSetting_GrammarSlotTypeSetting_Source_S3BucketName
-Source_S3ObjectKey <String>
The path to the grammar in the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExternalSourceSetting_GrammarSlotTypeSetting_Source_S3ObjectKey
-ValueSelectionSetting_ResolutionStrategy <SlotValueResolutionStrategy>
Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
  • OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.
  • TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the valueSelectionStrategy, the default is OriginalValue.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.LexModelsV2.Model.CreateSlotTypeResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z