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 Connect Service StartOutboundChatContact API operation.

Syntax

Start-CONNOutboundChatContact
-DestinationEndpoint_Address <String>
-SourceEndpoint_Address <String>
-Attribute <Hashtable>
-ChatDurationInMinute <Int32>
-ContactFlowId <String>
-InitialSystemMessage_Content <String>
-InitialSystemMessage_ContentType <String>
-ParticipantDetails_DisplayName <String>
-InstanceId <String>
-RelatedContactId <String>
-SegmentAttribute <Hashtable>
-SupportedMessagingContentType <String[]>
-DestinationEndpoint_Type <EndpointType>
-SourceEndpoint_Type <EndpointType>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonConnectConfig>

Description

Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created. SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created. This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action. For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:

Parameters

-Attribute <Hashtable>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes. 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)
AliasesAttributes
-ChatDurationInMinute <Int32>
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChatDurationInMinutes
-ClientConfig <AmazonConnectConfig>
Amazon.PowerShell.Cmdlets.CONN.AmazonConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContactFlowId <String>
The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
  • arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationEndpoint_Address <String>
Address of the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationEndpoint_Type <EndpointType>
Type of the endpoint.
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)
-InitialSystemMessage_Content <String>
The content of the chat message.
  • For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
  • For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
  • For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InitialSystemMessage_ContentType <String>
The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceId <String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParticipantDetails_DisplayName <String>
Display name of the participant.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelatedContactId <String>
The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SegmentAttribute <Hashtable>
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
  • Attribute keys can include only alphanumeric, -, and _.
  • This field can be used to show channel subtype, such as connect:Guide and connect:SMS.
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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSegmentAttributes
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ContactId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartOutboundChatContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartOutboundChatContactResponse 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)
-SourceEndpoint_Address <String>
Address of the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceEndpoint_Type <EndpointType>
Type of the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupportedMessagingContentType <String[]>
The supported chat message content types. Supported types are:
  • text/plain
  • text/markdown
  • application/json, application/vnd.amazonaws.connect.message.interactive
  • 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)
AliasesSupportedMessagingContentTypes

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.Connect.Model.StartOutboundChatContactResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Connect.Model.StartOutboundChatContactResponse) can be returned by specifying '-Select *'.
Administrator Guide
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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