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 StartImport API operation.

Syntax

Start-LMBV2Import
-ImportId <String>
-BotLocaleImportSpecification_BotId <String>
-BotImportSpecification_BotName <String>
-BotImportSpecification_BotTag <Hashtable>
-BotLocaleImportSpecification_BotVersion <String>
-DataPrivacy_ChildDirected <Boolean>
-VoiceSettings_Engine <VoiceEngine>
-FilePassword <String>
-BotImportSpecification_IdleSessionTTLInSecond <Int32>
-BotLocaleImportSpecification_LocaleId <String>
-MergeStrategy <MergeStrategy>
-BotLocaleImportSpecification_NluIntentConfidenceThreshold <Double>
-BotImportSpecification_RoleArn <String>
-BotImportSpecification_TestBotAliasTag <Hashtable>
-VoiceSettings_VoiceId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Starts importing a bot or bot locale from a zip archive that you uploaded to an S3 bucket.

Parameters

-BotImportSpecification_BotName <String>
The name that Amazon Lex should use for the bot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotImportSpecification_BotName
-BotImportSpecification_BotTag <Hashtable>
A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotImportSpecification_BotTags
-BotImportSpecification_IdleSessionTTLInSecond <Int32>
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotImportSpecification_IdleSessionTTLInSeconds
-BotImportSpecification_RoleArn <String>
The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotImportSpecification_RoleArn
-BotImportSpecification_TestBotAliasTag <Hashtable>
A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotImportSpecification_TestBotAliasTags
-BotLocaleImportSpecification_BotId <String>
The identifier of the bot to import the locale to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleImportSpecification_BotId
-BotLocaleImportSpecification_BotVersion <String>
The version of the bot to import the locale to. This can only be the DRAFT version of the bot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleImportSpecification_BotVersion
-BotLocaleImportSpecification_LocaleId <String>
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleImportSpecification_LocaleId
-BotLocaleImportSpecification_NluIntentConfidenceThreshold <Double>
Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot. For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
  • AMAZON.FallbackIntent
  • IntentA
  • IntentB
  • IntentC
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleImportSpecification_NluIntentConfidenceThreshold
-DataPrivacy_ChildDirected <Boolean>
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotImportSpecification_DataPrivacy_ChildDirected
-FilePassword <String>
The password used to encrypt the zip archive that contains the bot or bot locale definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
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)
-ImportId <String>
The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MergeStrategy <MergeStrategy>
The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ImportId parameter. The -PassThru parameter is deprecated, use -Select '^ImportId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.StartImportResponse). Specifying the name of a property of type Amazon.LexModelsV2.Model.StartImportResponse 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)
-VoiceSettings_Engine <VoiceEngine>
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.If you do not specify a value, the default is standard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleImportSpecification_VoiceSettings_Engine
-VoiceSettings_VoiceId <String>
The identifier of the Amazon Polly voice to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleImportSpecification_VoiceSettings_VoiceId

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