/******************************************************************************* * 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.SSMContacts; using Amazon.SSMContacts.Model; namespace Amazon.PowerShell.Cmdlets.SMC { /// /// Starts an engagement to a contact or escalation plan. The engagement engages each /// contact specified in the incident. /// [Cmdlet("Start", "SMCEngagement", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS Systems Manager Incident Manager Contacts StartEngagement API operation.", Operation = new[] {"StartEngagement"}, SelectReturnType = typeof(Amazon.SSMContacts.Model.StartEngagementResponse))] [AWSCmdletOutput("System.String or Amazon.SSMContacts.Model.StartEngagementResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.SSMContacts.Model.StartEngagementResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StartSMCEngagementCmdlet : AmazonSSMContactsClientCmdlet, IExecutor { #region Parameter ContactId /// /// /// The Amazon Resource Name (ARN) of the contact being engaged. /// /// #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 ContactId { get; set; } #endregion #region Parameter Content /// /// /// The secure content of the message that was sent to the contact. Use this field for /// engagements to VOICE or EMAIL. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Content { get; set; } #endregion #region Parameter IdempotencyToken /// /// /// A token ensuring that the operation is called only once with the specified details. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String IdempotencyToken { get; set; } #endregion #region Parameter IncidentId /// /// /// The ARN of the incident that the engagement is part of. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String IncidentId { get; set; } #endregion #region Parameter PublicContent /// /// /// The insecure content of the message that was sent to the contact. Use this field for /// engagements to SMS. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PublicContent { get; set; } #endregion #region Parameter PublicSubject /// /// /// The insecure subject of the message that was sent to the contact. Use this field for /// engagements to SMS. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PublicSubject { get; set; } #endregion #region Parameter Sender /// /// /// The user that started the engagement. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Sender { get; set; } #endregion #region Parameter Subject /// /// /// The secure subject of the message that was sent to the contact. Use this field for /// engagements to VOICE or EMAIL. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Subject { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'EngagementArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.StartEngagementResponse). /// Specifying the name of a property of type Amazon.SSMContacts.Model.StartEngagementResponse 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; } = "EngagementArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ContactId parameter. /// The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ContactId' 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 = FormatParameterValuesForConfirmationMsg(nameof(this.ContactId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-SMCEngagement (StartEngagement)")) { 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.ContactId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ContactId = this.ContactId; #if MODULAR if (this.ContactId == null && ParameterWasBound(nameof(this.ContactId))) { WriteWarning("You are passing $null as a value for parameter ContactId 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 context.Content = this.Content; #if MODULAR if (this.Content == null && ParameterWasBound(nameof(this.Content))) { WriteWarning("You are passing $null as a value for parameter Content 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 context.IdempotencyToken = this.IdempotencyToken; context.IncidentId = this.IncidentId; context.PublicContent = this.PublicContent; context.PublicSubject = this.PublicSubject; context.Sender = this.Sender; #if MODULAR if (this.Sender == null && ParameterWasBound(nameof(this.Sender))) { WriteWarning("You are passing $null as a value for parameter Sender 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 context.Subject = this.Subject; #if MODULAR if (this.Subject == null && ParameterWasBound(nameof(this.Subject))) { WriteWarning("You are passing $null as a value for parameter Subject 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 // 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.SSMContacts.Model.StartEngagementRequest(); if (cmdletContext.ContactId != null) { request.ContactId = cmdletContext.ContactId; } if (cmdletContext.Content != null) { request.Content = cmdletContext.Content; } if (cmdletContext.IdempotencyToken != null) { request.IdempotencyToken = cmdletContext.IdempotencyToken; } if (cmdletContext.IncidentId != null) { request.IncidentId = cmdletContext.IncidentId; } if (cmdletContext.PublicContent != null) { request.PublicContent = cmdletContext.PublicContent; } if (cmdletContext.PublicSubject != null) { request.PublicSubject = cmdletContext.PublicSubject; } if (cmdletContext.Sender != null) { request.Sender = cmdletContext.Sender; } if (cmdletContext.Subject != null) { request.Subject = cmdletContext.Subject; } 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.SSMContacts.Model.StartEngagementResponse CallAWSServiceOperation(IAmazonSSMContacts client, Amazon.SSMContacts.Model.StartEngagementRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Systems Manager Incident Manager Contacts", "StartEngagement"); try { #if DESKTOP return client.StartEngagement(request); #elif CORECLR return client.StartEngagementAsync(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.String ContactId { get; set; } public System.String Content { get; set; } public System.String IdempotencyToken { get; set; } public System.String IncidentId { get; set; } public System.String PublicContent { get; set; } public System.String PublicSubject { get; set; } public System.String Sender { get; set; } public System.String Subject { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.EngagementArn; } } }