/******************************************************************************* * 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.ComputeOptimizer; using Amazon.ComputeOptimizer.Model; namespace Amazon.PowerShell.Cmdlets.CO { /// /// Exports optimization recommendations for Amazon EBS volumes. /// /// /// /// Recommendations are exported in a comma-separated values (.csv) file, and its metadata /// in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple /// Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting /// Recommendations in the Compute Optimizer User Guide. /// /// You can have only one Amazon EBS volume export job in progress per Amazon Web Services /// Region. /// /// [Cmdlet("Export", "COEBSVolumeRecommendation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse")] [AWSCmdlet("Calls the AWS Compute Optimizer ExportEBSVolumeRecommendations API operation.", Operation = new[] {"ExportEBSVolumeRecommendations"}, SelectReturnType = typeof(Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse))] [AWSCmdletOutput("Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse", "This cmdlet returns an Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ExportCOEBSVolumeRecommendationCmdlet : AmazonComputeOptimizerClientCmdlet, IExecutor { #region Parameter AccountId /// /// /// The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume /// recommendations.If your account is the management account of an organization, use this parameter to /// specify the member account for which you want to export recommendations.This parameter cannot be specified together with the include member accounts parameter. /// The parameters are mutually exclusive.Recommendations for member accounts are not included in the export if this parameter, /// or the include member accounts parameter, is omitted.You can specify multiple account IDs per request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AccountIds")] public System.String[] AccountId { get; set; } #endregion #region Parameter S3DestinationConfig_Bucket /// /// /// The name of the Amazon S3 bucket to use as the destination for an export job. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String S3DestinationConfig_Bucket { get; set; } #endregion #region Parameter FieldsToExport /// /// /// The recommendations data to include in the export file. For more information about /// the fields that can be exported, see Exported /// files in the Compute Optimizer User Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String[] FieldsToExport { get; set; } #endregion #region Parameter FileFormat /// /// /// The format of the export file.The only export file format currently supported is Csv. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ComputeOptimizer.FileFormat")] public Amazon.ComputeOptimizer.FileFormat FileFormat { get; set; } #endregion #region Parameter Filter /// /// /// An array of objects to specify a filter that exports a more specific set of Amazon /// EBS volume recommendations. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Filters")] public Amazon.ComputeOptimizer.Model.EBSFilter[] Filter { get; set; } #endregion #region Parameter IncludeMemberAccount /// /// /// Indicates whether to include recommendations for resources in all member accounts /// of the organization if your account is the management account of an organization.The member accounts must also be opted in to Compute Optimizer, and trusted access /// for Compute Optimizer must be enabled in the organization account. For more information, /// see Compute /// Optimizer and Amazon Web Services Organizations trusted access in the Compute /// Optimizer User Guide.Recommendations for member accounts of the organization are not included in the export /// file if this parameter is omitted.This parameter cannot be specified together with the account IDs parameter. The parameters /// are mutually exclusive.Recommendations for member accounts are not included in the export if this parameter, /// or the account IDs parameter, is omitted. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("IncludeMemberAccounts")] public System.Boolean? IncludeMemberAccount { get; set; } #endregion #region Parameter S3DestinationConfig_KeyPrefix /// /// /// The Amazon S3 bucket prefix for an export job. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String S3DestinationConfig_KeyPrefix { 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.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse). /// Specifying the name of a property of type Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse 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 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 = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Export-COEBSVolumeRecommendation (ExportEBSVolumeRecommendations)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } if (this.AccountId != null) { context.AccountId = new List(this.AccountId); } if (this.FieldsToExport != null) { context.FieldsToExport = new List(this.FieldsToExport); } context.FileFormat = this.FileFormat; if (this.Filter != null) { context.Filter = new List(this.Filter); } context.IncludeMemberAccount = this.IncludeMemberAccount; context.S3DestinationConfig_Bucket = this.S3DestinationConfig_Bucket; context.S3DestinationConfig_KeyPrefix = this.S3DestinationConfig_KeyPrefix; // 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.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsRequest(); if (cmdletContext.AccountId != null) { request.AccountIds = cmdletContext.AccountId; } if (cmdletContext.FieldsToExport != null) { request.FieldsToExport = cmdletContext.FieldsToExport; } if (cmdletContext.FileFormat != null) { request.FileFormat = cmdletContext.FileFormat; } if (cmdletContext.Filter != null) { request.Filters = cmdletContext.Filter; } if (cmdletContext.IncludeMemberAccount != null) { request.IncludeMemberAccounts = cmdletContext.IncludeMemberAccount.Value; } // populate S3DestinationConfig var requestS3DestinationConfigIsNull = true; request.S3DestinationConfig = new Amazon.ComputeOptimizer.Model.S3DestinationConfig(); System.String requestS3DestinationConfig_s3DestinationConfig_Bucket = null; if (cmdletContext.S3DestinationConfig_Bucket != null) { requestS3DestinationConfig_s3DestinationConfig_Bucket = cmdletContext.S3DestinationConfig_Bucket; } if (requestS3DestinationConfig_s3DestinationConfig_Bucket != null) { request.S3DestinationConfig.Bucket = requestS3DestinationConfig_s3DestinationConfig_Bucket; requestS3DestinationConfigIsNull = false; } System.String requestS3DestinationConfig_s3DestinationConfig_KeyPrefix = null; if (cmdletContext.S3DestinationConfig_KeyPrefix != null) { requestS3DestinationConfig_s3DestinationConfig_KeyPrefix = cmdletContext.S3DestinationConfig_KeyPrefix; } if (requestS3DestinationConfig_s3DestinationConfig_KeyPrefix != null) { request.S3DestinationConfig.KeyPrefix = requestS3DestinationConfig_s3DestinationConfig_KeyPrefix; requestS3DestinationConfigIsNull = false; } // determine if request.S3DestinationConfig should be set to null if (requestS3DestinationConfigIsNull) { request.S3DestinationConfig = null; } 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.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsResponse CallAWSServiceOperation(IAmazonComputeOptimizer client, Amazon.ComputeOptimizer.Model.ExportEBSVolumeRecommendationsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Compute Optimizer", "ExportEBSVolumeRecommendations"); try { #if DESKTOP return client.ExportEBSVolumeRecommendations(request); #elif CORECLR return client.ExportEBSVolumeRecommendationsAsync(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 List AccountId { get; set; } public List FieldsToExport { get; set; } public Amazon.ComputeOptimizer.FileFormat FileFormat { get; set; } public List Filter { get; set; } public System.Boolean? IncludeMemberAccount { get; set; } public System.String S3DestinationConfig_Bucket { get; set; } public System.String S3DestinationConfig_KeyPrefix { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }