/// <summary>
/// The RegisterImage operation registers an AMI with Amazon EC2. Images must be
/// registered before they can be launched. For more information, see RunInstances.
/// Each AMI is associated with an unique ID which is provided by the Amazon EC2
/// service through the RegisterImage operation. During registration, Amazon EC2
/// retrieves the specified image manifest from Amazon S3 and verifies that the
/// image is owned by the user registering the image.
/// The image manifest is retrieved once and stored within the Amazon EC2. Any
/// modifications to an image in Amazon S3 invalidates this registration. If you
/// make changes to an image, deregister the previous image and register the new
/// image. For more information, see DeregisterImage.
///
/// </summary>
/// <param name="service">Instance of AmazonEC2 service</param>
/// <param name="request">RegisterImageRequest request</param>
public static void InvokeRegisterImage(AmazonEC2 service, RegisterImageRequest request)
{
try
{
RegisterImageResponse response = service.RegisterImage(request);
Console.WriteLine ("Service Response");
Console.WriteLine ("=============================================================================");
Console.WriteLine ();
Console.WriteLine(" RegisterImageResponse");
if (response.IsSetResponseMetadata())
{
Console.WriteLine(" ResponseMetadata");
ResponseMetadata responseMetadata = response.ResponseMetadata;
if (responseMetadata.IsSetRequestId())
{
Console.WriteLine(" RequestId");
Console.WriteLine(" {0}", responseMetadata.RequestId);
}
}
if (response.IsSetRegisterImageResult())
{
Console.WriteLine(" RegisterImageResult");
RegisterImageResult registerImageResult = response.RegisterImageResult;
if (registerImageResult.IsSetImageId())
{
Console.WriteLine(" ImageId");
Console.WriteLine(" {0}", registerImageResult.ImageId);
}
}
}
catch (AmazonEC2Exception ex)
{
Console.WriteLine("Caught Exception: " + ex.Message);
Console.WriteLine("Response Status Code: " + ex.StatusCode);
Console.WriteLine("Error Code: " + ex.ErrorCode);
Console.WriteLine("Error Type: " + ex.ErrorType);
Console.WriteLine("Request ID: " + ex.RequestId);
Console.WriteLine("XML: " + ex.XML);
}
}
/// <summary>
/// Initiates the asynchronous execution of the RegisterImage operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RegisterImage operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public Task<RegisterImageResponse> RegisterImageAsync(RegisterImageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new RegisterImageRequestMarshaller();
var unmarshaller = RegisterImageResponseUnmarshaller.Instance;
return InvokeAsync<RegisterImageRequest,RegisterImageResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
/// <summary>
/// Registers an AMI. When you're creating an AMI, this is the final step you must complete
/// before you can launch an instance from the AMI. For more information about creating
/// AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating
/// Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.
///
/// <note>
/// <para>
/// For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI
/// in a single request, so you don't have to register the AMI yourself.
/// </para>
/// </note>
/// <para>
/// You can also use <code>RegisterImage</code> to create an Amazon EBS-backed AMI from
/// a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching
/// an Instance from a Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.
/// </para>
///
/// <para>
/// If needed, you can deregister an AMI at any time. Any modifications you make to an
/// AMI backed by an instance store volume invalidates its registration. If you make changes
/// to an image, deregister the previous image and register the new image.
/// </para>
/// <note>
/// <para>
/// You can't register an image where a secondary (non-root) snapshot has AWS Marketplace
/// product codes.
/// </para>
/// </note>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the RegisterImage service method.</param>
///
/// <returns>The response from the RegisterImage service method, as returned by EC2.</returns>
public RegisterImageResponse RegisterImage(RegisterImageRequest request)
{
var marshaller = new RegisterImageRequestMarshaller();
var unmarshaller = RegisterImageResponseUnmarshaller.Instance;
return Invoke<RegisterImageRequest,RegisterImageResponse>(request, marshaller, unmarshaller);
}
/// <summary>
/// Initiates the asynchronous execution of the RegisterImage operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RegisterImage operation on AmazonEC2Client.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterImage
/// operation.</returns>
public IAsyncResult BeginRegisterImage(RegisterImageRequest request, AsyncCallback callback, object state)
{
var marshaller = new RegisterImageRequestMarshaller();
var unmarshaller = RegisterImageResponseUnmarshaller.Instance;
return BeginInvoke<RegisterImageRequest>(request, marshaller, unmarshaller,
callback, state);
}
IAsyncResult invokeRegisterImage(RegisterImageRequest registerImageRequest, AsyncCallback callback, object state, bool synchronized)
{
IRequest irequest = new RegisterImageRequestMarshaller().Marshall(registerImageRequest);
var unmarshaller = RegisterImageResponseUnmarshaller.GetInstance();
AsyncResult result = new AsyncResult(irequest, callback, state, synchronized, signer, unmarshaller);
Invoke(result);
return result;
}
/// <summary>
/// Initiates the asynchronous execution of the RegisterImage operation.
/// <seealso cref="Amazon.EC2.IAmazonEC2.RegisterImage"/>
/// </summary>
///
/// <param name="registerImageRequest">Container for the necessary parameters to execute the RegisterImage operation on AmazonEC2.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterImage
/// operation.</returns>
public IAsyncResult BeginRegisterImage(RegisterImageRequest registerImageRequest, AsyncCallback callback, object state)
{
return invokeRegisterImage(registerImageRequest, callback, state, false);
}
/// <summary>
/// <para>Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the
/// AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html"
/// >Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> <para><b>NOTE:</b> For Amazon EBS-backed
/// instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para> <para>You
/// can also use <c>RegisterImage</c> to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see <a
/// href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html" >Launching an Instance from a
/// Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> <para>If needed, you can deregister an AMI at any time. Any
/// modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image,
/// deregister the previous image and register the new image.</para> <para><b>NOTE:</b> You can't register an image where a secondary (non-root)
/// snapshot has AWS Marketplace product codes. </para>
/// </summary>
///
/// <param name="registerImageRequest">Container for the necessary parameters to execute the RegisterImage service method on AmazonEC2.</param>
///
/// <returns>The response from the RegisterImage service method, as returned by AmazonEC2.</returns>
///
public RegisterImageResponse RegisterImage(RegisterImageRequest registerImageRequest)
{
IAsyncResult asyncResult = invokeRegisterImage(registerImageRequest, null, null, true);
return EndRegisterImage(asyncResult);
}
/// <summary>
/// <para>Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the
/// AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> <para><b>NOTE:</b> For Amazon EBS-backed
/// instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para> <para>You
/// can also use <c>RegisterImage</c> to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching an Instance from a
/// Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> <para>If needed, you can deregister an AMI at any time. Any
/// modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image,
/// deregister the previous image and register the new image.</para> <para><b>NOTE:</b> You can't register an image where a secondary (non-root)
/// snapshot has AWS Marketplace product codes. </para>
/// </summary>
///
/// <param name="registerImageRequest">Container for the necessary parameters to execute the RegisterImage service method on AmazonEC2.</param>
///
/// <returns>The response from the RegisterImage service method, as returned by AmazonEC2.</returns>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
public Task<RegisterImageResponse> RegisterImageAsync(RegisterImageRequest registerImageRequest, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new RegisterImageRequestMarshaller();
var unmarshaller = RegisterImageResponseUnmarshaller.GetInstance();
return Invoke<IRequest, RegisterImageRequest, RegisterImageResponse>(registerImageRequest, marshaller, unmarshaller, signer, cancellationToken);
}
internal RegisterImageResponse RegisterImage(RegisterImageRequest request)
{
var task = RegisterImageAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
ExceptionDispatchInfo.Capture(e.InnerException).Throw();
return null;
}
}
/// <summary>
/// Initiates the asynchronous execution of the RegisterImage operation.
/// <seealso cref="Amazon.EC2.IAmazonEC2.RegisterImage"/>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RegisterImage operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public async Task<RegisterImageResponse> RegisterImageAsync(RegisterImageRequest request, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new RegisterImageRequestMarshaller();
var unmarshaller = RegisterImageResponseUnmarshaller.GetInstance();
var response = await Invoke<IRequest, RegisterImageRequest, RegisterImageResponse>(request, marshaller, unmarshaller, signer, cancellationToken)
.ConfigureAwait(continueOnCapturedContext: false);
return response;
}
/// <summary>
/// <para> The RegisterImage operation registers an AMI with Amazon EC2. Images must be registered before they can be launched. For more
/// information, see RunInstances. </para> <para> Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through
/// the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the
/// image is owned by the user registering the image. </para> <para> The image manifest is retrieved once and stored within the Amazon EC2. Any
/// modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and
/// register the new image. For more information, see DeregisterImage. </para>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the RegisterImage service method on AmazonEC2.</param>
///
/// <returns>The response from the RegisterImage service method, as returned by AmazonEC2.</returns>
public RegisterImageResponse RegisterImage(RegisterImageRequest request)
{
var task = RegisterImageAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
throw e.InnerException;
}
}
private Amazon.EC2.Model.RegisterImageResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.RegisterImageRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "RegisterImage");
try
{
#if DESKTOP
return(client.RegisterImage(request));
#elif CORECLR
return(client.RegisterImageAsync(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;
}
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.EC2.Model.RegisterImageRequest();
if (cmdletContext.Architecture != null)
{
request.Architecture = cmdletContext.Architecture;
}
if (cmdletContext.BillingProduct != null)
{
request.BillingProducts = cmdletContext.BillingProduct;
}
if (cmdletContext.BlockDeviceMapping != null)
{
request.BlockDeviceMappings = cmdletContext.BlockDeviceMapping;
}
if (cmdletContext.BootMode != null)
{
request.BootMode = cmdletContext.BootMode;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.EnaSupport != null)
{
request.EnaSupport = cmdletContext.EnaSupport.Value;
}
if (cmdletContext.ImageLocation != null)
{
request.ImageLocation = cmdletContext.ImageLocation;
}
if (cmdletContext.KernelId != null)
{
request.KernelId = cmdletContext.KernelId;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.RamdiskId != null)
{
request.RamdiskId = cmdletContext.RamdiskId;
}
if (cmdletContext.RootDeviceName != null)
{
request.RootDeviceName = cmdletContext.RootDeviceName;
}
if (cmdletContext.SriovNetSupport != null)
{
request.SriovNetSupport = cmdletContext.SriovNetSupport;
}
if (cmdletContext.VirtualizationType != null)
{
request.VirtualizationType = cmdletContext.VirtualizationType;
}
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);
}
protected override void ProcessRecord()
{
AmazonEC2 client = base.GetClient();
Amazon.EC2.Model.RegisterImageRequest request = new Amazon.EC2.Model.RegisterImageRequest();
request.ImageLocation = this._ImageLocation;
request.Name = this._Name;
request.Description = this._Description;
request.Architecture = this._Architecture;
request.KernelId = this._KernelId;
request.RamdiskId = this._RamdiskId;
request.RootDeviceName = this._RootDeviceName;
Amazon.EC2.Model.RegisterImageResponse response = client.RegisterImage(request);
base.WriteObject(response.RegisterImageResult.ImageId, true);
}
