/******************************************************************************* * 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.StepFunctions; using Amazon.StepFunctions.Model; namespace Amazon.PowerShell.Cmdlets.SFN { /// /// Creates a version /// from the current revision of a state machine. Use versions to create immutable snapshots /// of your state machine. You can start executions from versions either directly or with /// an alias. To create an alias, use CreateStateMachineAlias. /// /// /// /// You can publish up to 1000 versions for each state machine. You must manually delete /// unused versions using the DeleteStateMachineVersion API action. /// PublishStateMachineVersion is an idempotent API. It doesn't create a /// duplicate state machine version if it already exists for the current revision. Step /// Functions bases PublishStateMachineVersion's idempotency check on the /// stateMachineArn, name, and revisionId parameters. /// Requests with the same parameters return a successful idempotent response. If you /// don't specify a revisionId, Step Functions checks for a previously published /// version of the state machine's current revision. /// Related operations: /// [Cmdlet("Publish", "SFNStateMachineVersion", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.StepFunctions.Model.PublishStateMachineVersionResponse")] [AWSCmdlet("Calls the AWS Step Functions PublishStateMachineVersion API operation.", Operation = new[] {"PublishStateMachineVersion"}, SelectReturnType = typeof(Amazon.StepFunctions.Model.PublishStateMachineVersionResponse))] [AWSCmdletOutput("Amazon.StepFunctions.Model.PublishStateMachineVersionResponse", "This cmdlet returns an Amazon.StepFunctions.Model.PublishStateMachineVersionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class PublishSFNStateMachineVersionCmdlet : AmazonStepFunctionsClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter Description /// /// /// An optional description of the state machine version. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter RevisionId /// /// /// Only publish the state machine version if the current state machine's revision ID /// matches the specified ID.Use this option to avoid publishing a version if the state machine changed since you /// last updated it. If the specified revision ID doesn't match the state machine's current /// revision ID, the API returns ConflictException.To specify an initial revision ID for a state machine with no revision ID assigned, /// specify the string INITIAL for the revisionId parameter. /// For example, you can specify a revisionID of INITIAL when /// you create a state machine using the CreateStateMachine API action. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RevisionId { get; set; } #endregion #region Parameter StateMachineArn /// /// /// The Amazon Resource Name (ARN) of the state machine. /// /// #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 StateMachineArn { 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.StepFunctions.Model.PublishStateMachineVersionResponse). /// Specifying the name of a property of type Amazon.StepFunctions.Model.PublishStateMachineVersionResponse 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 StateMachineArn parameter. /// The -PassThru parameter is deprecated, use -Select '^StateMachineArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StateMachineArn' 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.StateMachineArn), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Publish-SFNStateMachineVersion (PublishStateMachineVersion)")) { 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.StateMachineArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Description = this.Description; context.RevisionId = this.RevisionId; context.StateMachineArn = this.StateMachineArn; #if MODULAR if (this.StateMachineArn == null && ParameterWasBound(nameof(this.StateMachineArn))) { WriteWarning("You are passing $null as a value for parameter StateMachineArn 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.StepFunctions.Model.PublishStateMachineVersionRequest(); if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.RevisionId != null) { request.RevisionId = cmdletContext.RevisionId; } if (cmdletContext.StateMachineArn != null) { request.StateMachineArn = cmdletContext.StateMachineArn; } 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.StepFunctions.Model.PublishStateMachineVersionResponse CallAWSServiceOperation(IAmazonStepFunctions client, Amazon.StepFunctions.Model.PublishStateMachineVersionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Step Functions", "PublishStateMachineVersion"); try { #if DESKTOP return client.PublishStateMachineVersion(request); #elif CORECLR return client.PublishStateMachineVersionAsync(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 Description { get; set; } public System.String RevisionId { get; set; } public System.String StateMachineArn { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }