/******************************************************************************* * 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.MainframeModernization; using Amazon.MainframeModernization.Model; namespace Amazon.PowerShell.Cmdlets.AMM { /// /// Lists all the available batch job definitions based on the batch job resources uploaded /// during the application creation. You can use the batch job definitions in the list /// to start a batch job. /// [Cmdlet("Get", "AMMBatchJobDefinitionList")] [OutputType("Amazon.MainframeModernization.Model.BatchJobDefinition")] [AWSCmdlet("Calls the M2 ListBatchJobDefinitions API operation.", Operation = new[] {"ListBatchJobDefinitions"}, SelectReturnType = typeof(Amazon.MainframeModernization.Model.ListBatchJobDefinitionsResponse))] [AWSCmdletOutput("Amazon.MainframeModernization.Model.BatchJobDefinition or Amazon.MainframeModernization.Model.ListBatchJobDefinitionsResponse", "This cmdlet returns a collection of Amazon.MainframeModernization.Model.BatchJobDefinition objects.", "The service call response (type Amazon.MainframeModernization.Model.ListBatchJobDefinitionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetAMMBatchJobDefinitionListCmdlet : AmazonMainframeModernizationClientCmdlet, IExecutor { #region Parameter ApplicationId /// /// /// The identifier of the application. /// /// #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 ApplicationId { get; set; } #endregion #region Parameter Prefix /// /// /// If the batch job definition is a FileBatchJobDefinition, the prefix allows you to /// search on the file names of FileBatchJobDefinitions. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Prefix { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of batch job definitions to return. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// A pagination token returned from a previous call to this operation. This specifies /// the next item to return. To return to the beginning of the list, exclude this parameter. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'BatchJobDefinitions'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MainframeModernization.Model.ListBatchJobDefinitionsResponse). /// Specifying the name of a property of type Amazon.MainframeModernization.Model.ListBatchJobDefinitionsResponse 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; } = "BatchJobDefinitions"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. /// The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); 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.ApplicationId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ApplicationId = this.ApplicationId; #if MODULAR if (this.ApplicationId == null && ParameterWasBound(nameof(this.ApplicationId))) { WriteWarning("You are passing $null as a value for parameter ApplicationId 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.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.Prefix = this.Prefix; // 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.MainframeModernization.Model.ListBatchJobDefinitionsRequest(); if (cmdletContext.ApplicationId != null) { request.ApplicationId = cmdletContext.ApplicationId; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.NextToken != null) { request.NextToken = cmdletContext.NextToken; } if (cmdletContext.Prefix != null) { request.Prefix = cmdletContext.Prefix; } 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.MainframeModernization.Model.ListBatchJobDefinitionsResponse CallAWSServiceOperation(IAmazonMainframeModernization client, Amazon.MainframeModernization.Model.ListBatchJobDefinitionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "M2", "ListBatchJobDefinitions"); try { #if DESKTOP return client.ListBatchJobDefinitions(request); #elif CORECLR return client.ListBatchJobDefinitionsAsync(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 ApplicationId { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public System.String Prefix { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.BatchJobDefinitions; } } }