AWS.Tools.ConnectParticipant.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ConnectParticipant</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.CompleteCONNPAttachmentUploadCmdlet"> <summary> Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. <para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.CompleteCONNPAttachmentUploadCmdlet.AttachmentId"> <summary> <para> <para>A list of unique identifiers for the attachments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.CompleteCONNPAttachmentUploadCmdlet.ConnectionToken"> <summary> <para> <para>The authentication token associated with the participant's connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.CompleteCONNPAttachmentUploadCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.CompleteCONNPAttachmentUploadCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectParticipant.Model.CompleteAttachmentUploadResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.CompleteCONNPAttachmentUploadCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionToken parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.CompleteCONNPAttachmentUploadCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.DisconnectCONNPParticipantCmdlet"> <summary> Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. <para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.DisconnectCONNPParticipantCmdlet.ConnectionToken"> <summary> <para> <para>The authentication token associated with the participant's connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.DisconnectCONNPParticipantCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.DisconnectCONNPParticipantCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectParticipant.Model.DisconnectParticipantResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.DisconnectCONNPParticipantCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionToken parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.DisconnectCONNPParticipantCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPAttachmentCmdlet"> <summary> Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. <para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPAttachmentCmdlet.AttachmentId"> <summary> <para> <para>A unique identifier for the attachment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPAttachmentCmdlet.ConnectionToken"> <summary> <para> <para>The authentication token associated with the participant's connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPAttachmentCmdlet.Select"> <summary> 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.ConnectParticipant.Model.GetAttachmentResponse). Specifying the name of a property of type Amazon.ConnectParticipant.Model.GetAttachmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPAttachmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionToken parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet"> <summary> Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. <para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.StartPosition_AbsoluteTime"> <summary> <para> <para>The time in ISO format where to start.</para><para>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.ConnectionToken"> <summary> <para> <para>The authentication token associated with the participant's connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.ContactId"> <summary> <para> <para>The contactId from the current contact chain for which transcript is needed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.StartPosition_Id"> <summary> <para> <para>The ID of the message or event where to start. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.StartPosition_MostRecent"> <summary> <para> <para>The start position of the most recent message where you want to start. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.ScanDirection"> <summary> <para> <para>The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.SortOrder"> <summary> <para> <para>The sort order for the records. Default: DESCENDING.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the page. Default: 10. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.NextToken"> <summary> <para> <para>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.Select"> <summary> 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.ConnectParticipant.Model.GetTranscriptResponse). Specifying the name of a property of type Amazon.ConnectParticipant.Model.GetTranscriptResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionToken parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.GetCONNPTranscriptCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.NewCONNPParticipantConnectionCmdlet"> <summary> Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken. <para> The participant token is valid for the lifetime of the participant – until they are part of a contact. </para><para> The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. </para><para> For chat, you need to publish the following on the established websocket connection: </para><para><code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code></para><para> Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before. </para><para><b>Message streaming support</b>: This API can also be used together with the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a> API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat message streaming</a> in the <i>Amazon Connect Administrator Guide</i>. </para><para><b>Feature specifications</b>: For information about feature specifications, such as the allowed number of open websocket connections per participant, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>. </para><note><para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.NewCONNPParticipantConnectionCmdlet.ConnectParticipant"> <summary> <para> <para>Amazon Connect Participant is used to mark the participant as connected for message streaming.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.NewCONNPParticipantConnectionCmdlet.ParticipantToken"> <summary> <para> <para>This is a header parameter.</para><para>The ParticipantToken as obtained from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a> API response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.NewCONNPParticipantConnectionCmdlet.Type"> <summary> <para> <para>Type of connection information required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.NewCONNPParticipantConnectionCmdlet.Select"> <summary> 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.ConnectParticipant.Model.CreateParticipantConnectionResponse). Specifying the name of a property of type Amazon.ConnectParticipant.Model.CreateParticipantConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.NewCONNPParticipantConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ParticipantToken parameter. The -PassThru parameter is deprecated, use -Select '^ParticipantToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.NewCONNPParticipantConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet"> <summary> Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. <para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet.ConnectionToken"> <summary> <para> <para>The authentication token associated with the participant's connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet.Content"> <summary> <para> <para>The content of the event to be sent (for example, message text). This is not yet supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet.ContentType"> <summary> <para> <para>The content type of the request. Supported types are:</para><ul><li><para>application/vnd.amazonaws.connect.event.typing</para></li><li><para>application/vnd.amazonaws.connect.event.connection.acknowledged</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet.Select"> <summary> 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.ConnectParticipant.Model.SendEventResponse). Specifying the name of a property of type Amazon.ConnectParticipant.Model.SendEventResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionToken parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPEventCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet"> <summary> Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken. <para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet.ConnectionToken"> <summary> <para> <para>The authentication token associated with the connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet.Content"> <summary> <para> <para>The content of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet.ContentType"> <summary> <para> <para>The type of the content. Supported types are text/plain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet.Select"> <summary> 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.ConnectParticipant.Model.SendMessageResponse). Specifying the name of a property of type Amazon.ConnectParticipant.Model.SendMessageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Content parameter. The -PassThru parameter is deprecated, use -Select '^Content' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.SendCONNPMessageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet"> <summary> Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. <para> The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 authentication</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.AttachmentName"> <summary> <para> <para>A case-sensitive name of the attachment being uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.AttachmentSizeInByte"> <summary> <para> <para>The size of the attachment in bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.ConnectionToken"> <summary> <para> <para>The authentication token associated with the participant's connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.ContentType"> <summary> <para> <para>Describes the MIME file type of the attachment. For a list of supported file types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.ClientToken"> <summary> <para> <para>A unique case sensitive identifier to support idempotency of request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.Select"> <summary> 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.ConnectParticipant.Model.StartAttachmentUploadResponse). Specifying the name of a property of type Amazon.ConnectParticipant.Model.StartAttachmentUploadResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionToken parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONNP.StartCONNPAttachmentUploadCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |