/*******************************************************************************
* 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.MediaConvert;
using Amazon.MediaConvert.Model;
namespace Amazon.PowerShell.Cmdlets.EMC
{
///
/// Modify one of your existing job templates.
///
[Cmdlet("Update", "EMCJobTemplate", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.MediaConvert.Model.JobTemplate")]
[AWSCmdlet("Calls the AWS Elemental MediaConvert UpdateJobTemplate API operation.", Operation = new[] {"UpdateJobTemplate"}, SelectReturnType = typeof(Amazon.MediaConvert.Model.UpdateJobTemplateResponse))]
[AWSCmdletOutput("Amazon.MediaConvert.Model.JobTemplate or Amazon.MediaConvert.Model.UpdateJobTemplateResponse",
"This cmdlet returns an Amazon.MediaConvert.Model.JobTemplate object.",
"The service call response (type Amazon.MediaConvert.Model.UpdateJobTemplateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateEMCJobTemplateCmdlet : AmazonMediaConvertClientCmdlet, IExecutor
{
#region Parameter Category
///
///
/// The new category for the job template, if you
/// are changing it.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Category { get; set; }
#endregion
#region Parameter Description
///
///
/// The new description for the job template,
/// if you are changing it.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter HopDestination
///
///
/// Optional list of hop destinations.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("HopDestinations")]
public Amazon.MediaConvert.Model.HopDestination[] HopDestination { get; set; }
#endregion
#region Parameter AccelerationSettings_Mode
///
///
/// Specify the conditions when the service will run
/// your job with accelerated transcoding.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.MediaConvert.AccelerationMode")]
public Amazon.MediaConvert.AccelerationMode AccelerationSettings_Mode { get; set; }
#endregion
#region Parameter Name
///
///
/// The name of the job template you are modifying
///
///
#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 Name { get; set; }
#endregion
#region Parameter Priority
///
///
/// Specify the relative priority for this job. In
/// any given queue, the service begins processing the job with the highest value first.
/// When more than one job has the same priority, the service begins processing the job
/// that you submitted first. If you don't specify a priority, the service uses the default
/// value 0.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Priority { get; set; }
#endregion
#region Parameter Queue
///
///
/// The new queue for the job template, if you are changing
/// it.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Queue { get; set; }
#endregion
#region Parameter Setting
///
///
/// JobTemplateSettings contains all the transcode
/// settings saved in the template that will be applied to jobs created from it.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Settings")]
public Amazon.MediaConvert.Model.JobTemplateSettings Setting { get; set; }
#endregion
#region Parameter StatusUpdateInterval
///
///
/// Specify how often MediaConvert sends
/// STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between
/// status updates. MediaConvert sends an update at this interval from the time the service
/// begins processing your job to the time it completes the transcode or encounters an
/// error.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.MediaConvert.StatusUpdateInterval")]
public Amazon.MediaConvert.StatusUpdateInterval StatusUpdateInterval { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'JobTemplate'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MediaConvert.Model.UpdateJobTemplateResponse).
/// Specifying the name of a property of type Amazon.MediaConvert.Model.UpdateJobTemplateResponse 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; } = "JobTemplate";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Name parameter.
/// The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Name' 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.Name), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-EMCJobTemplate (UpdateJobTemplate)"))
{
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.Name;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AccelerationSettings_Mode = this.AccelerationSettings_Mode;
context.Category = this.Category;
context.Description = this.Description;
if (this.HopDestination != null)
{
context.HopDestination = new List(this.HopDestination);
}
context.Name = this.Name;
#if MODULAR
if (this.Name == null && ParameterWasBound(nameof(this.Name)))
{
WriteWarning("You are passing $null as a value for parameter Name 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.Priority = this.Priority;
context.Queue = this.Queue;
context.Setting = this.Setting;
context.StatusUpdateInterval = this.StatusUpdateInterval;
// 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.MediaConvert.Model.UpdateJobTemplateRequest();
// populate AccelerationSettings
var requestAccelerationSettingsIsNull = true;
request.AccelerationSettings = new Amazon.MediaConvert.Model.AccelerationSettings();
Amazon.MediaConvert.AccelerationMode requestAccelerationSettings_accelerationSettings_Mode = null;
if (cmdletContext.AccelerationSettings_Mode != null)
{
requestAccelerationSettings_accelerationSettings_Mode = cmdletContext.AccelerationSettings_Mode;
}
if (requestAccelerationSettings_accelerationSettings_Mode != null)
{
request.AccelerationSettings.Mode = requestAccelerationSettings_accelerationSettings_Mode;
requestAccelerationSettingsIsNull = false;
}
// determine if request.AccelerationSettings should be set to null
if (requestAccelerationSettingsIsNull)
{
request.AccelerationSettings = null;
}
if (cmdletContext.Category != null)
{
request.Category = cmdletContext.Category;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.HopDestination != null)
{
request.HopDestinations = cmdletContext.HopDestination;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.Priority != null)
{
request.Priority = cmdletContext.Priority.Value;
}
if (cmdletContext.Queue != null)
{
request.Queue = cmdletContext.Queue;
}
if (cmdletContext.Setting != null)
{
request.Settings = cmdletContext.Setting;
}
if (cmdletContext.StatusUpdateInterval != null)
{
request.StatusUpdateInterval = cmdletContext.StatusUpdateInterval;
}
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.MediaConvert.Model.UpdateJobTemplateResponse CallAWSServiceOperation(IAmazonMediaConvert client, Amazon.MediaConvert.Model.UpdateJobTemplateRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Elemental MediaConvert", "UpdateJobTemplate");
try
{
#if DESKTOP
return client.UpdateJobTemplate(request);
#elif CORECLR
return client.UpdateJobTemplateAsync(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 Amazon.MediaConvert.AccelerationMode AccelerationSettings_Mode { get; set; }
public System.String Category { get; set; }
public System.String Description { get; set; }
public List HopDestination { get; set; }
public System.String Name { get; set; }
public System.Int32? Priority { get; set; }
public System.String Queue { get; set; }
public Amazon.MediaConvert.Model.JobTemplateSettings Setting { get; set; }
public Amazon.MediaConvert.StatusUpdateInterval StatusUpdateInterval { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.JobTemplate;
}
}
}