Amazon.PowerShell.Cmdlets.CONN.AmazonConnectClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Content of the message or event. This is required when
Type is
MESSAGE and for certain
ContentTypes when
Type is
EVENT.
- For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
- For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Type of content. This is required when
Type is
MESSAGE or
EVENT.
- For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
- For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Type of chat integration event.
Required? | True |
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) |
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NewSessionDetails_Attributes |
-NewSessionDetails_SupportedMessagingContentType <
String[]>
The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response. Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NewSessionDetails_SupportedMessagingContentTypes |
-ParticipantDetails_DisplayName <
String>
Display name of the participant.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NewSessionDetails_ParticipantDetails_DisplayName |
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.Connect.Model.SendChatIntegrationEventResponse). Specifying the name of a property of type Amazon.Connect.Model.SendChatIntegrationEventResponse 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) |
External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-StreamingConfiguration_StreamingEndpointArn <
String>
The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NewSessionDetails_StreamingConfiguration_StreamingEndpointArn |
Classification of a channel. This is used in part to uniquely identify chat. Valid value: ["connect:sms", connect:"WhatsApp"]
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |