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 Chime SDK Identity CreateAppInstanceBot API operation.

Syntax

New-CHMIDAppInstanceBot
-AppInstanceArn <String>
-ClientRequestToken <String>
-Lex_LexBotAliasArn <String>
-Lex_LocaleId <String>
-Metadata <String>
-Name <String>
-Lex_RespondsTo <RespondsTo>
-InvokedBy_StandardMessage <StandardMessages>
-Tag <Tag[]>
-InvokedBy_TargetedMessage <TargetedMessages>
-Lex_WelcomeIntent <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonChimeSDKIdentityConfig>

Description

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

Parameters

-AppInstanceArn <String>
The ARN of the AppInstance request.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonChimeSDKIdentityConfig>
Amazon.PowerShell.Cmdlets.CHMID.AmazonChimeSDKIdentityClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
The unique ID for the client making the request. Use different tokens for different AppInstanceBots.
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)
-InvokedBy_StandardMessage <StandardMessages>
Sets standard messages as the bot trigger. For standard messages:
  • ALL: The bot processes all standard messages.
  • AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.
  • MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.
  • NONE: The bot processes no standard messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Lex_InvokedBy_StandardMessages
-InvokedBy_TargetedMessage <TargetedMessages>
Sets targeted messages as the bot trigger. For targeted messages:
  • ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.
  • NONE: The bot processes no targeted messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Lex_InvokedBy_TargetedMessages
-Lex_LexBotAliasArn <String>
The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Lex_LexBotAliasArn
-Lex_LocaleId <String>
Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Lex_LocaleId
-Lex_RespondsTo <RespondsTo>
Deprecated. Use InvokedBy instead.Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Lex_RespondsTo
-Lex_WelcomeIntent <String>
The name of the welcome intent configured in the Amazon Lex V2 bot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_Lex_WelcomeIntent
-Metadata <String>
The request metadata. Limited to a 1KB string in UTF-8.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The user's name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AppInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^AppInstanceArn' 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 'AppInstanceBotArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.CreateAppInstanceBotResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.CreateAppInstanceBotResponse 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)
-Tag <Tag[]>
The tags assigned to the AppInstanceBot.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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

System.String or Amazon.ChimeSDKIdentity.Model.CreateAppInstanceBotResponse
This cmdlet returns a System.String object. The service call response (type Amazon.ChimeSDKIdentity.Model.CreateAppInstanceBotResponse) 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