/*******************************************************************************
* 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.FinSpaceData;
using Amazon.FinSpaceData.Model;
namespace Amazon.PowerShell.Cmdlets.FNSP
{
///
/// Updates a FinSpace Changeset.
///
[Cmdlet("Update", "FNSPChangeset", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.FinSpaceData.Model.UpdateChangesetResponse")]
[AWSCmdlet("Calls the FinSpace Public API UpdateChangeset API operation.", Operation = new[] {"UpdateChangeset"}, SelectReturnType = typeof(Amazon.FinSpaceData.Model.UpdateChangesetResponse))]
[AWSCmdletOutput("Amazon.FinSpaceData.Model.UpdateChangesetResponse",
"This cmdlet returns an Amazon.FinSpaceData.Model.UpdateChangesetResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateFNSPChangesetCmdlet : AmazonFinSpaceDataClientCmdlet, IExecutor
{
#region Parameter ChangesetId
///
///
/// The unique identifier for the Changeset to update.
///
///
#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 ChangesetId { get; set; }
#endregion
#region Parameter DatasetId
///
///
/// The unique identifier for the FinSpace Dataset in which the Changeset is created.
///
///
#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 DatasetId { get; set; }
#endregion
#region Parameter FormatParam
///
///
/// Options that define the structure of the source file(s) including the format type
/// (formatType
), header row (withHeader
), data separation character
/// (separator
) and the type of compression (compression
). formatType
is a required attribute and can have the following values:
/// PARQUET
– Parquet source file format.CSV
– CSV source file format.JSON
– JSON source file format.XML
– XML source file format.
Here is an example of how you could specify the formatParams
: "formatParams": { "formatType": "CSV", "withHeader": "true", "separator":
/// ",", "compression":"None" }
Note that if you only provide formatType
as CSV
, the rest
/// of the attributes will automatically default to CSV values as following: { "withHeader": "true", "separator": "," }
For more information about supported file formats, see Supported
/// Data Types and File Formats in the FinSpace User Guide.
///
///
#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("FormatParams")]
public System.Collections.Hashtable FormatParam { get; set; }
#endregion
#region Parameter SourceParam
///
///
/// Options that define the location of the data being ingested (s3SourcePath
)
/// and the source of the changeset (sourceType
).Both s3SourcePath
and sourceType
are required attributes.Here is an example of how you could specify the sourceParams
: "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
/// "sourceType": "S3" }
The S3 path that you specify must allow the FinSpace role access. To do that, you
/// first need to configure the IAM policy on S3 bucket. For more information, see Loading
/// data from an Amazon S3 Bucket using the FinSpace APIsection.
///
///
#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("SourceParams")]
public System.Collections.Hashtable SourceParam { get; set; }
#endregion
#region Parameter ClientToken
///
///
/// A token that ensures idempotency. This token expires in 10 minutes.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientToken { 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.FinSpaceData.Model.UpdateChangesetResponse).
/// Specifying the name of a property of type Amazon.FinSpaceData.Model.UpdateChangesetResponse 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 DatasetId parameter.
/// The -PassThru parameter is deprecated, use -Select '^DatasetId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DatasetId' 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.DatasetId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-FNSPChangeset (UpdateChangeset)"))
{
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.DatasetId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ChangesetId = this.ChangesetId;
#if MODULAR
if (this.ChangesetId == null && ParameterWasBound(nameof(this.ChangesetId)))
{
WriteWarning("You are passing $null as a value for parameter ChangesetId 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.ClientToken = this.ClientToken;
context.DatasetId = this.DatasetId;
#if MODULAR
if (this.DatasetId == null && ParameterWasBound(nameof(this.DatasetId)))
{
WriteWarning("You are passing $null as a value for parameter DatasetId 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.FormatParam != null)
{
context.FormatParam = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.FormatParam.Keys)
{
context.FormatParam.Add((String)hashKey, (String)(this.FormatParam[hashKey]));
}
}
#if MODULAR
if (this.FormatParam == null && ParameterWasBound(nameof(this.FormatParam)))
{
WriteWarning("You are passing $null as a value for parameter FormatParam 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.SourceParam != null)
{
context.SourceParam = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.SourceParam.Keys)
{
context.SourceParam.Add((String)hashKey, (String)(this.SourceParam[hashKey]));
}
}
#if MODULAR
if (this.SourceParam == null && ParameterWasBound(nameof(this.SourceParam)))
{
WriteWarning("You are passing $null as a value for parameter SourceParam 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.FinSpaceData.Model.UpdateChangesetRequest();
if (cmdletContext.ChangesetId != null)
{
request.ChangesetId = cmdletContext.ChangesetId;
}
if (cmdletContext.ClientToken != null)
{
request.ClientToken = cmdletContext.ClientToken;
}
if (cmdletContext.DatasetId != null)
{
request.DatasetId = cmdletContext.DatasetId;
}
if (cmdletContext.FormatParam != null)
{
request.FormatParams = cmdletContext.FormatParam;
}
if (cmdletContext.SourceParam != null)
{
request.SourceParams = cmdletContext.SourceParam;
}
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.FinSpaceData.Model.UpdateChangesetResponse CallAWSServiceOperation(IAmazonFinSpaceData client, Amazon.FinSpaceData.Model.UpdateChangesetRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "FinSpace Public API", "UpdateChangeset");
try
{
#if DESKTOP
return client.UpdateChangeset(request);
#elif CORECLR
return client.UpdateChangesetAsync(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 ChangesetId { get; set; }
public System.String ClientToken { get; set; }
public System.String DatasetId { get; set; }
public Dictionary FormatParam { get; set; }
public Dictionary SourceParam { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}