/******************************************************************************* * 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.CognitoIdentityProvider; using Amazon.CognitoIdentityProvider.Model; namespace Amazon.PowerShell.Cmdlets.CGIP { /// /// Confirms registration of a new user. /// [Cmdlet("Confirm", "CGIPUserRegistration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the Amazon Cognito Identity Provider ConfirmSignUp API operation. This operation uses anonymous authentication and does not require credential parameters to be supplied.", Operation = new[] {"ConfirmSignUp"}, SelectReturnType = typeof(Amazon.CognitoIdentityProvider.Model.ConfirmSignUpResponse))] [AWSCmdletOutput("None or Amazon.CognitoIdentityProvider.Model.ConfirmSignUpResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.CognitoIdentityProvider.Model.ConfirmSignUpResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ConfirmCGIPUserRegistrationCmdlet : AnonymousAmazonCognitoIdentityProviderClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter AnalyticsMetadata_AnalyticsEndpointId /// /// /// The endpoint ID. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AnalyticsMetadata_AnalyticsEndpointId { get; set; } #endregion #region Parameter ClientId /// /// /// The ID of the app client associated with the user pool. /// /// #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 ClientId { get; set; } #endregion #region Parameter ClientMetadata /// /// /// A map of custom key-value pairs that you can provide as input for any custom workflows /// that this action triggers.You create custom workflows by assigning Lambda functions to user pool triggers. When /// you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is /// assigned to the post confirmation trigger. When Amazon Cognito invokes this /// function, it passes a JSON payload, which the function receives as input. This payload /// contains a clientMetadata attribute, which provides the data that you /// assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function /// code in Lambda, you can process the clientMetadata value to enhance your /// workflow for your specific needs.For more information, see /// Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito /// Developer Guide.When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the /// following:
  • Store the ClientMetadata value. This data is available only to Lambda triggers that /// are assigned to a user pool to support custom workflows. If your user pool configuration /// doesn't include triggers, the ClientMetadata parameter serves no purpose.
  • Validate the ClientMetadata value.
  • Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Collections.Hashtable ClientMetadata { get; set; } #endregion #region Parameter ConfirmationCode /// /// /// The confirmation code sent by a user's request to confirm registration. /// /// #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 ConfirmationCode { get; set; } #endregion #region Parameter UserContextData_EncodedData /// /// /// Encoded device-fingerprint details that your app collected with the Amazon Cognito /// context data collection library. For more information, see Adding /// user device and session data to API requests. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String UserContextData_EncodedData { get; set; } #endregion #region Parameter ForceAliasCreation /// /// /// Boolean to be specified to force user confirmation irrespective of existing alias. /// By default set to False. If this parameter is set to True /// and the phone number/email used for sign up confirmation already exists as an alias /// with a different user, the API call will migrate the alias from the previous user /// to the newly created user being confirmed. If set to False, the API will /// throw an AliasExistsException error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? ForceAliasCreation { get; set; } #endregion #region Parameter UserContextData_IpAddress /// /// /// The source IP address of your user's device. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String UserContextData_IpAddress { get; set; } #endregion #region Parameter SecretHash /// /// /// A keyed-hash message authentication code (HMAC) calculated using the secret key of /// a user pool client and username plus the client ID in the message. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SecretHash { get; set; } #endregion #region Parameter Username /// /// /// The user name of the user whose registration you want to confirm. /// /// #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 Username { get; set; } #endregion #region Parameter Select /// /// 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.CognitoIdentityProvider.Model.ConfirmSignUpResponse). /// 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 Username parameter. /// The -PassThru parameter is deprecated, use -Select '^Username' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Username' 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.Username), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Confirm-CGIPUserRegistration (ConfirmSignUp)")) { 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.Username; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AnalyticsMetadata_AnalyticsEndpointId = this.AnalyticsMetadata_AnalyticsEndpointId; context.ClientId = this.ClientId; #if MODULAR if (this.ClientId == null && ParameterWasBound(nameof(this.ClientId))) { WriteWarning("You are passing $null as a value for parameter ClientId 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.ClientMetadata != null) { context.ClientMetadata = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.ClientMetadata.Keys) { context.ClientMetadata.Add((String)hashKey, (String)(this.ClientMetadata[hashKey])); } } context.ConfirmationCode = this.ConfirmationCode; #if MODULAR if (this.ConfirmationCode == null && ParameterWasBound(nameof(this.ConfirmationCode))) { WriteWarning("You are passing $null as a value for parameter ConfirmationCode 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.ForceAliasCreation = this.ForceAliasCreation; context.SecretHash = this.SecretHash; context.UserContextData_EncodedData = this.UserContextData_EncodedData; context.UserContextData_IpAddress = this.UserContextData_IpAddress; context.Username = this.Username; #if MODULAR if (this.Username == null && ParameterWasBound(nameof(this.Username))) { WriteWarning("You are passing $null as a value for parameter Username 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.CognitoIdentityProvider.Model.ConfirmSignUpRequest(); // populate AnalyticsMetadata var requestAnalyticsMetadataIsNull = true; request.AnalyticsMetadata = new Amazon.CognitoIdentityProvider.Model.AnalyticsMetadataType(); System.String requestAnalyticsMetadata_analyticsMetadata_AnalyticsEndpointId = null; if (cmdletContext.AnalyticsMetadata_AnalyticsEndpointId != null) { requestAnalyticsMetadata_analyticsMetadata_AnalyticsEndpointId = cmdletContext.AnalyticsMetadata_AnalyticsEndpointId; } if (requestAnalyticsMetadata_analyticsMetadata_AnalyticsEndpointId != null) { request.AnalyticsMetadata.AnalyticsEndpointId = requestAnalyticsMetadata_analyticsMetadata_AnalyticsEndpointId; requestAnalyticsMetadataIsNull = false; } // determine if request.AnalyticsMetadata should be set to null if (requestAnalyticsMetadataIsNull) { request.AnalyticsMetadata = null; } if (cmdletContext.ClientId != null) { request.ClientId = cmdletContext.ClientId; } if (cmdletContext.ClientMetadata != null) { request.ClientMetadata = cmdletContext.ClientMetadata; } if (cmdletContext.ConfirmationCode != null) { request.ConfirmationCode = cmdletContext.ConfirmationCode; } if (cmdletContext.ForceAliasCreation != null) { request.ForceAliasCreation = cmdletContext.ForceAliasCreation.Value; } if (cmdletContext.SecretHash != null) { request.SecretHash = cmdletContext.SecretHash; } // populate UserContextData var requestUserContextDataIsNull = true; request.UserContextData = new Amazon.CognitoIdentityProvider.Model.UserContextDataType(); System.String requestUserContextData_userContextData_EncodedData = null; if (cmdletContext.UserContextData_EncodedData != null) { requestUserContextData_userContextData_EncodedData = cmdletContext.UserContextData_EncodedData; } if (requestUserContextData_userContextData_EncodedData != null) { request.UserContextData.EncodedData = requestUserContextData_userContextData_EncodedData; requestUserContextDataIsNull = false; } System.String requestUserContextData_userContextData_IpAddress = null; if (cmdletContext.UserContextData_IpAddress != null) { requestUserContextData_userContextData_IpAddress = cmdletContext.UserContextData_IpAddress; } if (requestUserContextData_userContextData_IpAddress != null) { request.UserContextData.IpAddress = requestUserContextData_userContextData_IpAddress; requestUserContextDataIsNull = false; } // determine if request.UserContextData should be set to null if (requestUserContextDataIsNull) { request.UserContextData = null; } if (cmdletContext.Username != null) { request.Username = cmdletContext.Username; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_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.CognitoIdentityProvider.Model.ConfirmSignUpResponse CallAWSServiceOperation(IAmazonCognitoIdentityProvider client, Amazon.CognitoIdentityProvider.Model.ConfirmSignUpRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Cognito Identity Provider", "ConfirmSignUp"); try { #if DESKTOP return client.ConfirmSignUp(request); #elif CORECLR return client.ConfirmSignUpAsync(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 AnalyticsMetadata_AnalyticsEndpointId { get; set; } public System.String ClientId { get; set; } public Dictionary ClientMetadata { get; set; } public System.String ConfirmationCode { get; set; } public System.Boolean? ForceAliasCreation { get; set; } public System.String SecretHash { get; set; } public System.String UserContextData_EncodedData { get; set; } public System.String UserContextData_IpAddress { get; set; } public System.String Username { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }