/*******************************************************************************
* 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.Personalize;
using Amazon.Personalize.Model;
namespace Amazon.PowerShell.Cmdlets.PERS
{
///
/// Amazon.Personalize.IAmazonPersonalize.CreateDatasetImportJob
///
[Cmdlet("New", "PERSDatasetImportJob", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Personalize CreateDatasetImportJob API operation.", Operation = new[] {"CreateDatasetImportJob"}, SelectReturnType = typeof(Amazon.Personalize.Model.CreateDatasetImportJobResponse))]
[AWSCmdletOutput("System.String or Amazon.Personalize.Model.CreateDatasetImportJobResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.Personalize.Model.CreateDatasetImportJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewPERSDatasetImportJobCmdlet : AmazonPersonalizeClientCmdlet, IExecutor
{
#region Parameter DataSource_DataLocation
///
///
/// The path to the Amazon S3 bucket where the data that you want to upload to your dataset
/// is stored. For example: s3://bucket-name/folder-name/
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DataSource_DataLocation { get; set; }
#endregion
#region Parameter DatasetArn
///
///
/// The ARN of the dataset that receives the imported data.
///
///
#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 DatasetArn { get; set; }
#endregion
#region Parameter ImportMode
///
///
/// Specify how to add the new records to an existing dataset. The default import mode
/// is FULL
. If you haven't imported bulk records into the dataset previously,
/// you can only specify FULL
.- Specify
FULL
to overwrite all existing bulk data in your dataset. Data
/// you imported individually is not replaced. - Specify
INCREMENTAL
to append the new records to the existing data in
/// your dataset. Amazon Personalize replaces any record with the same ID with the new
/// one.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Personalize.ImportMode")]
public Amazon.Personalize.ImportMode ImportMode { get; set; }
#endregion
#region Parameter JobName
///
///
/// The name for the dataset import job.
///
///
#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 JobName { get; set; }
#endregion
#region Parameter PublishAttributionMetricsToS3
///
///
/// If you created a metric attribution, specify whether to publish metrics for this import
/// job to Amazon S3
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Boolean? PublishAttributionMetricsToS3 { get; set; }
#endregion
#region Parameter RoleArn
///
///
/// The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
///
///
#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 RoleArn { get; set; }
#endregion
#region Parameter Tag
///
///
/// A list of tags
/// to apply to the dataset import job.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.Personalize.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'DatasetImportJobArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Personalize.Model.CreateDatasetImportJobResponse).
/// Specifying the name of a property of type Amazon.Personalize.Model.CreateDatasetImportJobResponse 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; } = "DatasetImportJobArn";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the JobName parameter.
/// The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^JobName' 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.JobName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-PERSDatasetImportJob (CreateDatasetImportJob)"))
{
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.JobName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.DatasetArn = this.DatasetArn;
#if MODULAR
if (this.DatasetArn == null && ParameterWasBound(nameof(this.DatasetArn)))
{
WriteWarning("You are passing $null as a value for parameter DatasetArn 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.DataSource_DataLocation = this.DataSource_DataLocation;
context.ImportMode = this.ImportMode;
context.JobName = this.JobName;
#if MODULAR
if (this.JobName == null && ParameterWasBound(nameof(this.JobName)))
{
WriteWarning("You are passing $null as a value for parameter JobName 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.PublishAttributionMetricsToS3 = this.PublishAttributionMetricsToS3;
context.RoleArn = this.RoleArn;
#if MODULAR
if (this.RoleArn == null && ParameterWasBound(nameof(this.RoleArn)))
{
WriteWarning("You are passing $null as a value for parameter RoleArn 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.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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.Personalize.Model.CreateDatasetImportJobRequest();
if (cmdletContext.DatasetArn != null)
{
request.DatasetArn = cmdletContext.DatasetArn;
}
// populate DataSource
var requestDataSourceIsNull = true;
request.DataSource = new Amazon.Personalize.Model.DataSource();
System.String requestDataSource_dataSource_DataLocation = null;
if (cmdletContext.DataSource_DataLocation != null)
{
requestDataSource_dataSource_DataLocation = cmdletContext.DataSource_DataLocation;
}
if (requestDataSource_dataSource_DataLocation != null)
{
request.DataSource.DataLocation = requestDataSource_dataSource_DataLocation;
requestDataSourceIsNull = false;
}
// determine if request.DataSource should be set to null
if (requestDataSourceIsNull)
{
request.DataSource = null;
}
if (cmdletContext.ImportMode != null)
{
request.ImportMode = cmdletContext.ImportMode;
}
if (cmdletContext.JobName != null)
{
request.JobName = cmdletContext.JobName;
}
if (cmdletContext.PublishAttributionMetricsToS3 != null)
{
request.PublishAttributionMetricsToS3 = cmdletContext.PublishAttributionMetricsToS3.Value;
}
if (cmdletContext.RoleArn != null)
{
request.RoleArn = cmdletContext.RoleArn;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.Personalize.Model.CreateDatasetImportJobResponse CallAWSServiceOperation(IAmazonPersonalize client, Amazon.Personalize.Model.CreateDatasetImportJobRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Personalize", "CreateDatasetImportJob");
try
{
#if DESKTOP
return client.CreateDatasetImportJob(request);
#elif CORECLR
return client.CreateDatasetImportJobAsync(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 DatasetArn { get; set; }
public System.String DataSource_DataLocation { get; set; }
public Amazon.Personalize.ImportMode ImportMode { get; set; }
public System.String JobName { get; set; }
public System.Boolean? PublishAttributionMetricsToS3 { get; set; }
public System.String RoleArn { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DatasetImportJobArn;
}
}
}