/*******************************************************************************
* 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.AWSMarketplaceMetering;
using Amazon.AWSMarketplaceMetering.Model;
namespace Amazon.PowerShell.Cmdlets.MM
{
///
/// Paid container software products sold through AWS Marketplace must integrate with
/// the AWS Marketplace Metering Service and call the RegisterUsage operation
/// for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon
/// EKS aren't required to call RegisterUsage, but you may choose to do so
/// if you would like to receive usage data in your seller reports. The sections below
/// explain the behavior of RegisterUsage. RegisterUsage performs
/// two primary functions: metering and entitlement.
///
/// - Entitlement:
RegisterUsage allows you to verify that the customer
/// running your paid software is subscribed to your product on AWS Marketplace, enabling
/// you to guard against unauthorized use. Your container image that integrates with RegisterUsage
/// is only required to guard against unauthorized use at container startup, as such a
/// CustomerNotSubscribedException or PlatformNotSupportedException
/// will only be thrown on the initial call to RegisterUsage. Subsequent
/// calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will
/// not throw a CustomerNotSubscribedException, even if the customer unsubscribes
/// while the Amazon ECS task or Amazon EKS pod is still running.
/// - Metering:
RegisterUsage meters software use per ECS task, per
/// hour, or per pod for Amazon EKS with usage prorated to the second. A minimum of 1
/// minute of usage applies to tasks that are short lived. For example, if a customer
/// has a 10 node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon
/// Set, then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and
/// the customer will be charged: (10 * hourly_rate). Metering for software use is automatically
/// handled by the AWS Marketplace Metering Control Plane -- your software is not required
/// to perform any metering specific actions, other than call RegisterUsage
/// once for metering of software use to commence. The AWS Marketplace Metering Control
/// Plane will also continue to bill customers for running ECS tasks and Amazon EKS pods,
/// regardless of the customers subscription state, removing the need for your software
/// to perform entitlement checks at runtime.
///
///
[Cmdlet("Register", "MMUsage", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.AWSMarketplaceMetering.Model.RegisterUsageResponse")]
[AWSCmdlet("Calls the AWS Marketplace Metering RegisterUsage API operation.", Operation = new[] {"RegisterUsage"}, SelectReturnType = typeof(Amazon.AWSMarketplaceMetering.Model.RegisterUsageResponse))]
[AWSCmdletOutput("Amazon.AWSMarketplaceMetering.Model.RegisterUsageResponse",
"This cmdlet returns an Amazon.AWSMarketplaceMetering.Model.RegisterUsageResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RegisterMMUsageCmdlet : AmazonAWSMarketplaceMeteringClientCmdlet, IExecutor
{
#region Parameter Nonce
///
///
/// (Optional) To scope down the registration to a specific running software instance
/// and guard against replay attacks.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Nonce { get; set; }
#endregion
#region Parameter ProductCode
///
///
/// Product code is used to uniquely identify a product in AWS Marketplace. The product
/// code should be the same as the one used during the publishing of a new product.
///
///
#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 ProductCode { get; set; }
#endregion
#region Parameter PublicKeyVersion
///
///
/// Public Key Version provided by AWS Marketplace
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.Int32? PublicKeyVersion { 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.AWSMarketplaceMetering.Model.RegisterUsageResponse).
/// Specifying the name of a property of type Amazon.AWSMarketplaceMetering.Model.RegisterUsageResponse 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 ProductCode parameter.
/// The -PassThru parameter is deprecated, use -Select '^ProductCode' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ProductCode' 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.ProductCode), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Register-MMUsage (RegisterUsage)"))
{
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.ProductCode;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Nonce = this.Nonce;
context.ProductCode = this.ProductCode;
#if MODULAR
if (this.ProductCode == null && ParameterWasBound(nameof(this.ProductCode)))
{
WriteWarning("You are passing $null as a value for parameter ProductCode 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.PublicKeyVersion = this.PublicKeyVersion;
#if MODULAR
if (this.PublicKeyVersion == null && ParameterWasBound(nameof(this.PublicKeyVersion)))
{
WriteWarning("You are passing $null as a value for parameter PublicKeyVersion 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.AWSMarketplaceMetering.Model.RegisterUsageRequest();
if (cmdletContext.Nonce != null)
{
request.Nonce = cmdletContext.Nonce;
}
if (cmdletContext.ProductCode != null)
{
request.ProductCode = cmdletContext.ProductCode;
}
if (cmdletContext.PublicKeyVersion != null)
{
request.PublicKeyVersion = cmdletContext.PublicKeyVersion.Value;
}
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.AWSMarketplaceMetering.Model.RegisterUsageResponse CallAWSServiceOperation(IAmazonAWSMarketplaceMetering client, Amazon.AWSMarketplaceMetering.Model.RegisterUsageRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Marketplace Metering", "RegisterUsage");
try
{
#if DESKTOP
return client.RegisterUsage(request);
#elif CORECLR
return client.RegisterUsageAsync(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 Nonce { get; set; }
public System.String ProductCode { get; set; }
public System.Int32? PublicKeyVersion { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}