/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.ConnectParticipant;
using Amazon.ConnectParticipant.Model;
namespace Amazon.PowerShell.Cmdlets.CONNP
{
///
/// Creates the participant's connection.
///
/// ParticipantToken
is used for invoking this API instead of ConnectionToken
.
///
/// The participant token is valid for the lifetime of the participant – until they are
/// part of a contact.
///
/// The response URL for WEBSOCKET
Type has a connect expiry timeout of 100s.
/// Clients must manually connect to the returned websocket URL and subscribe to the desired
/// topic.
///
/// For chat, you need to publish the following on the established websocket connection:
/// {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
/// 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.
/// Message streaming support: This API can also be used together with the StartContactStreaming
/// API to create a participant connection for chat contacts that are not using a websocket.
/// For more information about message streaming, Enable
/// real-time chat message streaming in the Amazon Connect Administrator Guide.
/// Feature specifications: For information about feature specifications, such
/// as the allowed number of open websocket connections per participant, see Feature
/// specifications in the Amazon Connect Administrator Guide.
///
/// The Amazon Connect Participant Service APIs do not use Signature
/// Version 4 authentication.
///
///
[Cmdlet("New", "CONNPParticipantConnection", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.ConnectParticipant.Model.CreateParticipantConnectionResponse")]
[AWSCmdlet("Calls the Amazon Connect Participant Service CreateParticipantConnection API operation.", Operation = new[] {"CreateParticipantConnection"}, SelectReturnType = typeof(Amazon.ConnectParticipant.Model.CreateParticipantConnectionResponse))]
[AWSCmdletOutput("Amazon.ConnectParticipant.Model.CreateParticipantConnectionResponse",
"This cmdlet returns an Amazon.ConnectParticipant.Model.CreateParticipantConnectionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewCONNPParticipantConnectionCmdlet : AmazonConnectParticipantClientCmdlet, IExecutor
{
#region Parameter ConnectParticipant
///
///
/// Amazon Connect Participant is used to mark the participant as connected for customer
/// participant in message streaming, as well as for agent or manager participant in non-streaming
/// chats.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? ConnectParticipant { get; set; }
#endregion
#region Parameter ParticipantToken
///
///
/// This is a header parameter.The ParticipantToken as obtained from StartChatContact
/// API response.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ParticipantToken { get; set; }
#endregion
#region Parameter Type
///
///
/// Type of connection information required. This can be omitted if ConnectParticipant
/// is true
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String[] Type { get; set; }
#endregion
#region Parameter Select
///
/// 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.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
///
/// 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.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ParticipantToken' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = string.Empty;
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-CONNPParticipantConnection (CreateParticipantConnection)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.ParticipantToken;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ConnectParticipant = this.ConnectParticipant;
context.ParticipantToken = this.ParticipantToken;
#if MODULAR
if (this.ParticipantToken == null && ParameterWasBound(nameof(this.ParticipantToken)))
{
WriteWarning("You are passing $null as a value for parameter ParticipantToken which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
if (this.Type != null)
{
context.Type = new List(this.Type);
}
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.ConnectParticipant.Model.CreateParticipantConnectionRequest();
if (cmdletContext.ConnectParticipant != null)
{
request.ConnectParticipant = cmdletContext.ConnectParticipant.Value;
}
if (cmdletContext.ParticipantToken != null)
{
request.ParticipantToken = cmdletContext.ParticipantToken;
}
if (cmdletContext.Type != null)
{
request.Type = cmdletContext.Type;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.ConnectParticipant.Model.CreateParticipantConnectionResponse CallAWSServiceOperation(IAmazonConnectParticipant client, Amazon.ConnectParticipant.Model.CreateParticipantConnectionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Connect Participant Service", "CreateParticipantConnection");
try
{
#if DESKTOP
return client.CreateParticipantConnection(request);
#elif CORECLR
return client.CreateParticipantConnectionAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.Boolean? ConnectParticipant { get; set; }
public System.String ParticipantToken { get; set; }
public List Type { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}