/******************************************************************************* * 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.QuickSight; using Amazon.QuickSight.Model; namespace Amazon.PowerShell.Cmdlets.QS { /// /// Starts an asynchronous job that generates a dashboard snapshot. You can request up /// to one paginated PDF and up to five CSVs per API call. /// /// /// /// Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once /// the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain /// the download URIs that the job generates. /// /// [Cmdlet("Start", "QSDashboardSnapshotJob", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.QuickSight.Model.StartDashboardSnapshotJobResponse")] [AWSCmdlet("Calls the Amazon QuickSight StartDashboardSnapshotJob API operation.", Operation = new[] {"StartDashboardSnapshotJob"}, SelectReturnType = typeof(Amazon.QuickSight.Model.StartDashboardSnapshotJobResponse))] [AWSCmdletOutput("Amazon.QuickSight.Model.StartDashboardSnapshotJobResponse", "This cmdlet returns an Amazon.QuickSight.Model.StartDashboardSnapshotJobResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StartQSDashboardSnapshotJobCmdlet : AmazonQuickSightClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter UserConfiguration_AnonymousUser /// /// /// An array of records that describe the anonymous users that the dashboard snapshot /// is generated for. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("UserConfiguration_AnonymousUsers")] public Amazon.QuickSight.Model.SnapshotAnonymousUser[] UserConfiguration_AnonymousUser { get; set; } #endregion #region Parameter AwsAccountId /// /// /// The ID of the Amazon Web Services account that the dashboard snapshot job is executed /// in. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String AwsAccountId { get; set; } #endregion #region Parameter DashboardId /// /// /// The ID of the dashboard that you want to start a snapshot job for. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String DashboardId { get; set; } #endregion #region Parameter Parameters_DateTimeParameter /// /// /// The parameters that have a data type of date-time. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SnapshotConfiguration_Parameters_DateTimeParameters")] public Amazon.QuickSight.Model.DateTimeParameter[] Parameters_DateTimeParameter { get; set; } #endregion #region Parameter Parameters_DecimalParameter /// /// /// The parameters that have a data type of decimal. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SnapshotConfiguration_Parameters_DecimalParameters")] public Amazon.QuickSight.Model.DecimalParameter[] Parameters_DecimalParameter { get; set; } #endregion #region Parameter SnapshotConfiguration_FileGroup /// /// /// A list of SnapshotJobResultFileGroup objects that contain information /// about the snapshot that is generated. This list can hold a maximum of 6 FileGroup /// configurations. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("SnapshotConfiguration_FileGroups")] public Amazon.QuickSight.Model.SnapshotFileGroup[] SnapshotConfiguration_FileGroup { get; set; } #endregion #region Parameter Parameters_IntegerParameter /// /// /// The parameters that have a data type of integer. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SnapshotConfiguration_Parameters_IntegerParameters")] public Amazon.QuickSight.Model.IntegerParameter[] Parameters_IntegerParameter { get; set; } #endregion #region Parameter DestinationConfiguration_S3Destination /// /// /// A list of SnapshotS3DestinationConfiguration objects that contain Amazon /// S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration. /// /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SnapshotConfiguration_DestinationConfiguration_S3Destinations")] public Amazon.QuickSight.Model.SnapshotS3DestinationConfiguration[] DestinationConfiguration_S3Destination { get; set; } #endregion #region Parameter SnapshotJobId /// /// /// An ID for the dashboard snapshot job. This ID is unique to the dashboard while the /// job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob /// while the job runs. You can reuse this ID for another job 24 hours after the current /// job is completed. /// /// #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 SnapshotJobId { get; set; } #endregion #region Parameter Parameters_StringParameter /// /// /// The parameters that have a data type of string. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("SnapshotConfiguration_Parameters_StringParameters")] public Amazon.QuickSight.Model.StringParameter[] Parameters_StringParameter { 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.QuickSight.Model.StartDashboardSnapshotJobResponse). /// Specifying the name of a property of type Amazon.QuickSight.Model.StartDashboardSnapshotJobResponse 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 SnapshotJobId parameter. /// The -PassThru parameter is deprecated, use -Select '^SnapshotJobId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SnapshotJobId' 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 = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-QSDashboardSnapshotJob (StartDashboardSnapshotJob)")) { 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.SnapshotJobId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AwsAccountId = this.AwsAccountId; #if MODULAR if (this.AwsAccountId == null && ParameterWasBound(nameof(this.AwsAccountId))) { WriteWarning("You are passing $null as a value for parameter AwsAccountId 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.DashboardId = this.DashboardId; #if MODULAR if (this.DashboardId == null && ParameterWasBound(nameof(this.DashboardId))) { WriteWarning("You are passing $null as a value for parameter DashboardId 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 if (this.DestinationConfiguration_S3Destination != null) { context.DestinationConfiguration_S3Destination = new List(this.DestinationConfiguration_S3Destination); } if (this.SnapshotConfiguration_FileGroup != null) { context.SnapshotConfiguration_FileGroup = new List(this.SnapshotConfiguration_FileGroup); } #if MODULAR if (this.SnapshotConfiguration_FileGroup == null && ParameterWasBound(nameof(this.SnapshotConfiguration_FileGroup))) { WriteWarning("You are passing $null as a value for parameter SnapshotConfiguration_FileGroup 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 if (this.Parameters_DateTimeParameter != null) { context.Parameters_DateTimeParameter = new List(this.Parameters_DateTimeParameter); } if (this.Parameters_DecimalParameter != null) { context.Parameters_DecimalParameter = new List(this.Parameters_DecimalParameter); } if (this.Parameters_IntegerParameter != null) { context.Parameters_IntegerParameter = new List(this.Parameters_IntegerParameter); } if (this.Parameters_StringParameter != null) { context.Parameters_StringParameter = new List(this.Parameters_StringParameter); } context.SnapshotJobId = this.SnapshotJobId; #if MODULAR if (this.SnapshotJobId == null && ParameterWasBound(nameof(this.SnapshotJobId))) { WriteWarning("You are passing $null as a value for parameter SnapshotJobId 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 if (this.UserConfiguration_AnonymousUser != null) { context.UserConfiguration_AnonymousUser = new List(this.UserConfiguration_AnonymousUser); } // 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.QuickSight.Model.StartDashboardSnapshotJobRequest(); if (cmdletContext.AwsAccountId != null) { request.AwsAccountId = cmdletContext.AwsAccountId; } if (cmdletContext.DashboardId != null) { request.DashboardId = cmdletContext.DashboardId; } // populate SnapshotConfiguration var requestSnapshotConfigurationIsNull = true; request.SnapshotConfiguration = new Amazon.QuickSight.Model.SnapshotConfiguration(); List requestSnapshotConfiguration_snapshotConfiguration_FileGroup = null; if (cmdletContext.SnapshotConfiguration_FileGroup != null) { requestSnapshotConfiguration_snapshotConfiguration_FileGroup = cmdletContext.SnapshotConfiguration_FileGroup; } if (requestSnapshotConfiguration_snapshotConfiguration_FileGroup != null) { request.SnapshotConfiguration.FileGroups = requestSnapshotConfiguration_snapshotConfiguration_FileGroup; requestSnapshotConfigurationIsNull = false; } Amazon.QuickSight.Model.SnapshotDestinationConfiguration requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration = null; // populate DestinationConfiguration var requestSnapshotConfiguration_snapshotConfiguration_DestinationConfigurationIsNull = true; requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration = new Amazon.QuickSight.Model.SnapshotDestinationConfiguration(); List requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration_destinationConfiguration_S3Destination = null; if (cmdletContext.DestinationConfiguration_S3Destination != null) { requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration_destinationConfiguration_S3Destination = cmdletContext.DestinationConfiguration_S3Destination; } if (requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration_destinationConfiguration_S3Destination != null) { requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration.S3Destinations = requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration_destinationConfiguration_S3Destination; requestSnapshotConfiguration_snapshotConfiguration_DestinationConfigurationIsNull = false; } // determine if requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration should be set to null if (requestSnapshotConfiguration_snapshotConfiguration_DestinationConfigurationIsNull) { requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration = null; } if (requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration != null) { request.SnapshotConfiguration.DestinationConfiguration = requestSnapshotConfiguration_snapshotConfiguration_DestinationConfiguration; requestSnapshotConfigurationIsNull = false; } Amazon.QuickSight.Model.Parameters requestSnapshotConfiguration_snapshotConfiguration_Parameters = null; // populate Parameters var requestSnapshotConfiguration_snapshotConfiguration_ParametersIsNull = true; requestSnapshotConfiguration_snapshotConfiguration_Parameters = new Amazon.QuickSight.Model.Parameters(); List requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DateTimeParameter = null; if (cmdletContext.Parameters_DateTimeParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DateTimeParameter = cmdletContext.Parameters_DateTimeParameter; } if (requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DateTimeParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters.DateTimeParameters = requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DateTimeParameter; requestSnapshotConfiguration_snapshotConfiguration_ParametersIsNull = false; } List requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DecimalParameter = null; if (cmdletContext.Parameters_DecimalParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DecimalParameter = cmdletContext.Parameters_DecimalParameter; } if (requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DecimalParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters.DecimalParameters = requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_DecimalParameter; requestSnapshotConfiguration_snapshotConfiguration_ParametersIsNull = false; } List requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_IntegerParameter = null; if (cmdletContext.Parameters_IntegerParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_IntegerParameter = cmdletContext.Parameters_IntegerParameter; } if (requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_IntegerParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters.IntegerParameters = requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_IntegerParameter; requestSnapshotConfiguration_snapshotConfiguration_ParametersIsNull = false; } List requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_StringParameter = null; if (cmdletContext.Parameters_StringParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_StringParameter = cmdletContext.Parameters_StringParameter; } if (requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_StringParameter != null) { requestSnapshotConfiguration_snapshotConfiguration_Parameters.StringParameters = requestSnapshotConfiguration_snapshotConfiguration_Parameters_parameters_StringParameter; requestSnapshotConfiguration_snapshotConfiguration_ParametersIsNull = false; } // determine if requestSnapshotConfiguration_snapshotConfiguration_Parameters should be set to null if (requestSnapshotConfiguration_snapshotConfiguration_ParametersIsNull) { requestSnapshotConfiguration_snapshotConfiguration_Parameters = null; } if (requestSnapshotConfiguration_snapshotConfiguration_Parameters != null) { request.SnapshotConfiguration.Parameters = requestSnapshotConfiguration_snapshotConfiguration_Parameters; requestSnapshotConfigurationIsNull = false; } // determine if request.SnapshotConfiguration should be set to null if (requestSnapshotConfigurationIsNull) { request.SnapshotConfiguration = null; } if (cmdletContext.SnapshotJobId != null) { request.SnapshotJobId = cmdletContext.SnapshotJobId; } // populate UserConfiguration var requestUserConfigurationIsNull = true; request.UserConfiguration = new Amazon.QuickSight.Model.SnapshotUserConfiguration(); List requestUserConfiguration_userConfiguration_AnonymousUser = null; if (cmdletContext.UserConfiguration_AnonymousUser != null) { requestUserConfiguration_userConfiguration_AnonymousUser = cmdletContext.UserConfiguration_AnonymousUser; } if (requestUserConfiguration_userConfiguration_AnonymousUser != null) { request.UserConfiguration.AnonymousUsers = requestUserConfiguration_userConfiguration_AnonymousUser; requestUserConfigurationIsNull = false; } // determine if request.UserConfiguration should be set to null if (requestUserConfigurationIsNull) { request.UserConfiguration = 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.QuickSight.Model.StartDashboardSnapshotJobResponse CallAWSServiceOperation(IAmazonQuickSight client, Amazon.QuickSight.Model.StartDashboardSnapshotJobRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon QuickSight", "StartDashboardSnapshotJob"); try { #if DESKTOP return client.StartDashboardSnapshotJob(request); #elif CORECLR return client.StartDashboardSnapshotJobAsync(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 AwsAccountId { get; set; } public System.String DashboardId { get; set; } public List DestinationConfiguration_S3Destination { get; set; } public List SnapshotConfiguration_FileGroup { get; set; } public List Parameters_DateTimeParameter { get; set; } public List Parameters_DecimalParameter { get; set; } public List Parameters_IntegerParameter { get; set; } public List Parameters_StringParameter { get; set; } public System.String SnapshotJobId { get; set; } public List UserConfiguration_AnonymousUser { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }