/******************************************************************************* * 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.TranscribeService; using Amazon.TranscribeService.Model; namespace Amazon.PowerShell.Cmdlets.TRS { /// <summary> /// Provides a list of medical transcription jobs that match the specified criteria. If /// no criteria are specified, all medical transcription jobs are returned. /// /// /// <para> /// To get detailed information about a specific medical transcription job, use the operation. /// </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. /// </summary> [Cmdlet("Get", "TRSMedicalTranscriptionJobList")] [OutputType("Amazon.TranscribeService.Model.MedicalTranscriptionJobSummary")] [AWSCmdlet("Calls the Amazon Transcribe Service ListMedicalTranscriptionJobs API operation.", Operation = new[] {"ListMedicalTranscriptionJobs"}, SelectReturnType = typeof(Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse))] [AWSCmdletOutput("Amazon.TranscribeService.Model.MedicalTranscriptionJobSummary or Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse", "This cmdlet returns a collection of Amazon.TranscribeService.Model.MedicalTranscriptionJobSummary objects.", "The service call response (type Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetTRSMedicalTranscriptionJobListCmdlet : AmazonTranscribeServiceClientCmdlet, IExecutor { #region Parameter JobNameContain /// <summary> /// <para> /// <para>Returns only the medical transcription jobs that contain the specified string. The /// search is not case sensitive.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] [Alias("JobNameContains")] public System.String JobNameContain { get; set; } #endregion #region Parameter MaxResult /// <summary> /// <para> /// <para>The maximum number of medical transcription jobs to return in each page of results. /// If there are fewer results than the value that you specify, only the actual results /// are returned. If you don't specify a value, a default of 5 is used.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// <summary> /// <para> /// <para>If your <code>ListMedicalTranscriptionJobs</code> request returns more results than /// can be displayed, <code>NextToken</code> is displayed in the response with an associated /// string. To get the next page of results, copy this string and repeat your request, /// including <code>NextToken</code> with the value of the copied string. Repeat as needed /// to view all your results.</para> /// </para> /// <para> /// <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. /// <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter Status /// <summary> /// <para> /// <para>Returns only medical transcription jobs with the specified status. Jobs are ordered /// by creation date, with the newest job first. If you don't include <code>Status</code>, /// all medical transcription jobs are returned.</para> /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.TranscribeService.TranscriptionJobStatus")] public Amazon.TranscribeService.TranscriptionJobStatus Status { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'MedicalTranscriptionJobSummaries'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse). /// Specifying the name of a property of type Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "MedicalTranscriptionJobSummaries"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the JobNameContain parameter. /// The -PassThru parameter is deprecated, use -Select '^JobNameContain' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^JobNameContain' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter NoAutoIteration /// <summary> /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken /// as the start point. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { 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<Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse, GetTRSMedicalTranscriptionJobListCmdlet>(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.JobNameContain; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.JobNameContain = this.JobNameContain; context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.Status = this.Status; // 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; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // create request and set iteration invariants var request = new Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsRequest(); if (cmdletContext.JobNameContain != null) { request.JobNameContains = cmdletContext.JobNameContain; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.Status != null) { request.Status = cmdletContext.Status; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.NextToken; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.NextToken; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse CallAWSServiceOperation(IAmazonTranscribeService client, Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Transcribe Service", "ListMedicalTranscriptionJobs"); try { #if DESKTOP return client.ListMedicalTranscriptionJobs(request); #elif CORECLR return client.ListMedicalTranscriptionJobsAsync(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 JobNameContain { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public Amazon.TranscribeService.TranscriptionJobStatus Status { get; set; } public System.Func<Amazon.TranscribeService.Model.ListMedicalTranscriptionJobsResponse, GetTRSMedicalTranscriptionJobListCmdlet, object> Select { get; set; } = (response, cmdlet) => response.MedicalTranscriptionJobSummaries; } } }