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

Syntax

New-LMBV2Export
-FileFormat <ImportExportFileFormat>
-BotExportSpecification_BotId <String>
-BotLocaleExportSpecification_BotId <String>
-CustomVocabularyExportSpecification_BotId <String>
-BotExportSpecification_BotVersion <String>
-BotLocaleExportSpecification_BotVersion <String>
-CustomVocabularyExportSpecification_BotVersion <String>
-FilePassword <String>
-BotLocaleExportSpecification_LocaleId <String>
-CustomVocabularyExportSpecification_LocaleId <String>
-TestSetExportSpecification_TestSetId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonLexModelsV2Config>

Description

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot. You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale. For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

Parameters

-BotExportSpecification_BotId <String>
The identifier of the bot assigned by Amazon Lex.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotExportSpecification_BotId
-BotExportSpecification_BotVersion <String>
The version of the bot that was exported. This will be either DRAFT or the version number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotExportSpecification_BotVersion
-BotLocaleExportSpecification_BotId <String>
The identifier of the bot to create the locale for.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleExportSpecification_BotId
-BotLocaleExportSpecification_BotVersion <String>
The version of the bot to export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleExportSpecification_BotVersion
-BotLocaleExportSpecification_LocaleId <String>
The identifier of the language and locale to export. The string must match one of the locales in the bot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_BotLocaleExportSpecification_LocaleId
-ClientConfig <AmazonLexModelsV2Config>
Amazon.PowerShell.Cmdlets.LMBV2.AmazonLexModelsV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomVocabularyExportSpecification_BotId <String>
The identifier of the bot that contains the custom vocabulary to export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_CustomVocabularyExportSpecification_BotId
-CustomVocabularyExportSpecification_BotVersion <String>
The version of the bot that contains the custom vocabulary to export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_CustomVocabularyExportSpecification_BotVersion
-CustomVocabularyExportSpecification_LocaleId <String>
The locale of the bot that contains the custom vocabulary to export.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_CustomVocabularyExportSpecification_LocaleId
-FileFormat <ImportExportFileFormat>
The file format of the bot or bot locale definition files.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-FilePassword <String>
An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the FileFormat parameter. The -PassThru parameter is deprecated, use -Select '^FileFormat' 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.CreateExportResponse). Specifying the name of a property of type Amazon.LexModelsV2.Model.CreateExportResponse 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)
-TestSetExportSpecification_TestSetId <String>
The unique identifier of the test set.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceSpecification_TestSetExportSpecification_TestSetId

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

Amazon.LexModelsV2.Model.CreateExportResponse
This cmdlet returns an Amazon.LexModelsV2.Model.CreateExportResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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