/*******************************************************************************
* 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.PinpointSMSVoiceV2;
using Amazon.PinpointSMSVoiceV2.Model;
namespace Amazon.PowerShell.Cmdlets.SMSV
{
///
/// Deletes an existing keyword from an origination phone number or pool.
///
///
///
/// A keyword is a word that you can search for on a particular phone number or pool.
/// It is also a specific word or phrase that an end user can send to your number to elicit
/// a response, such as an informational message or a special offer. When your number
/// receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable
/// message.
///
/// Keywords "HELP" and "STOP" can't be deleted or modified.
///
///
[Cmdlet("Remove", "SMSVKeyword", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)]
[OutputType("Amazon.PinpointSMSVoiceV2.Model.DeleteKeywordResponse")]
[AWSCmdlet("Calls the Amazon Pinpoint SMS Voice V2 DeleteKeyword API operation.", Operation = new[] {"DeleteKeyword"}, SelectReturnType = typeof(Amazon.PinpointSMSVoiceV2.Model.DeleteKeywordResponse))]
[AWSCmdletOutput("Amazon.PinpointSMSVoiceV2.Model.DeleteKeywordResponse",
"This cmdlet returns an Amazon.PinpointSMSVoiceV2.Model.DeleteKeywordResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RemoveSMSVKeywordCmdlet : AmazonPinpointSMSVoiceV2ClientCmdlet, IExecutor
{
#region Parameter Keyword
///
///
/// The keyword to delete.
///
///
#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 Keyword { get; set; }
#endregion
#region Parameter OriginationIdentity
///
///
/// The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or
/// PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId
/// and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
///
///
#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 OriginationIdentity { 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.PinpointSMSVoiceV2.Model.DeleteKeywordResponse).
/// Specifying the name of a property of type Amazon.PinpointSMSVoiceV2.Model.DeleteKeywordResponse 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 OriginationIdentity parameter.
/// The -PassThru parameter is deprecated, use -Select '^OriginationIdentity' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^OriginationIdentity' 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.OriginationIdentity), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-SMSVKeyword (DeleteKeyword)"))
{
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.OriginationIdentity;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Keyword = this.Keyword;
#if MODULAR
if (this.Keyword == null && ParameterWasBound(nameof(this.Keyword)))
{
WriteWarning("You are passing $null as a value for parameter Keyword 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.OriginationIdentity = this.OriginationIdentity;
#if MODULAR
if (this.OriginationIdentity == null && ParameterWasBound(nameof(this.OriginationIdentity)))
{
WriteWarning("You are passing $null as a value for parameter OriginationIdentity 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.PinpointSMSVoiceV2.Model.DeleteKeywordRequest();
if (cmdletContext.Keyword != null)
{
request.Keyword = cmdletContext.Keyword;
}
if (cmdletContext.OriginationIdentity != null)
{
request.OriginationIdentity = cmdletContext.OriginationIdentity;
}
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.PinpointSMSVoiceV2.Model.DeleteKeywordResponse CallAWSServiceOperation(IAmazonPinpointSMSVoiceV2 client, Amazon.PinpointSMSVoiceV2.Model.DeleteKeywordRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Pinpoint SMS Voice V2", "DeleteKeyword");
try
{
#if DESKTOP
return client.DeleteKeyword(request);
#elif CORECLR
return client.DeleteKeywordAsync(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 Keyword { get; set; }
public System.String OriginationIdentity { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}