/*******************************************************************************
* 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.ForecastService;
using Amazon.ForecastService.Model;
namespace Amazon.PowerShell.Cmdlets.FRC
{
///
/// Exports an Explainability resource created by the CreateExplainability operation.
/// Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.
///
///
///
/// You must specify a DataDestination object that includes an Amazon S3 bucket
/// and an Identity and Access Management (IAM) role that Amazon Forecast can assume to
/// access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
///
/// The Status
of the export job must be ACTIVE
before you can
/// access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport
/// operation.
///
///
[Cmdlet("New", "FRCExplainabilityExport", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon Forecast Service CreateExplainabilityExport API operation.", Operation = new[] {"CreateExplainabilityExport"}, SelectReturnType = typeof(Amazon.ForecastService.Model.CreateExplainabilityExportResponse))]
[AWSCmdletOutput("System.String or Amazon.ForecastService.Model.CreateExplainabilityExportResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.ForecastService.Model.CreateExplainabilityExportResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewFRCExplainabilityExportCmdlet : AmazonForecastServiceClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter ExplainabilityArn
///
///
/// The Amazon Resource Name (ARN) of the Explainability to export.
///
///
#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 ExplainabilityArn { get; set; }
#endregion
#region Parameter ExplainabilityExportName
///
///
/// A unique name for the Explainability export.
///
///
#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 ExplainabilityExportName { get; set; }
#endregion
#region Parameter Format
///
///
/// The format of the exported data, CSV or PARQUET.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Format { get; set; }
#endregion
#region Parameter S3Config_KMSKeyArn
///
///
/// The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Destination_S3Config_KMSKeyArn")]
public System.String S3Config_KMSKeyArn { get; set; }
#endregion
#region Parameter S3Config_Path
///
///
/// The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon
/// S3 bucket.
///
///
#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]
[Alias("Destination_S3Config_Path")]
public System.String S3Config_Path { get; set; }
#endregion
#region Parameter S3Config_RoleArn
///
///
/// The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can
/// assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn
/// key, the role must allow access to the key.Passing a role across Amazon Web Services accounts is not allowed. If you pass a role
/// that isn't in your account, you get an InvalidInputException
error.
///
///
#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]
[Alias("Destination_S3Config_RoleArn")]
public System.String S3Config_RoleArn { get; set; }
#endregion
#region Parameter Tag
///
///
/// Optional metadata to help you categorize and organize your resources. Each tag consists
/// of a key and an optional value, both of which you define. Tag keys and values are
/// case sensitive.The following restrictions apply to tags:- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and +
/// - = . _ : / @. If your tagging schema is used across other services and resources,
/// the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
/// or AWS:
. Values can have this prefix. If a tag value has aws
/// as its prefix but the key does not, Forecast considers it to be a user tag and will
/// count against the limit of 50 tags. Tags with only the key prefix of aws
/// do not count against your tags per resource limit. You cannot edit or delete tag keys
/// with this prefix.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.ForecastService.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'ExplainabilityExportArn'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ForecastService.Model.CreateExplainabilityExportResponse).
/// Specifying the name of a property of type Amazon.ForecastService.Model.CreateExplainabilityExportResponse 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; } = "ExplainabilityExportArn";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ExplainabilityArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^ExplainabilityArn' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ExplainabilityArn' 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.ExplainabilityArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-FRCExplainabilityExport (CreateExplainabilityExport)"))
{
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.ExplainabilityArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.S3Config_KMSKeyArn = this.S3Config_KMSKeyArn;
context.S3Config_Path = this.S3Config_Path;
#if MODULAR
if (this.S3Config_Path == null && ParameterWasBound(nameof(this.S3Config_Path)))
{
WriteWarning("You are passing $null as a value for parameter S3Config_Path 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.S3Config_RoleArn = this.S3Config_RoleArn;
#if MODULAR
if (this.S3Config_RoleArn == null && ParameterWasBound(nameof(this.S3Config_RoleArn)))
{
WriteWarning("You are passing $null as a value for parameter S3Config_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
context.ExplainabilityArn = this.ExplainabilityArn;
#if MODULAR
if (this.ExplainabilityArn == null && ParameterWasBound(nameof(this.ExplainabilityArn)))
{
WriteWarning("You are passing $null as a value for parameter ExplainabilityArn 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.ExplainabilityExportName = this.ExplainabilityExportName;
#if MODULAR
if (this.ExplainabilityExportName == null && ParameterWasBound(nameof(this.ExplainabilityExportName)))
{
WriteWarning("You are passing $null as a value for parameter ExplainabilityExportName 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.Format = this.Format;
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.ForecastService.Model.CreateExplainabilityExportRequest();
// populate Destination
var requestDestinationIsNull = true;
request.Destination = new Amazon.ForecastService.Model.DataDestination();
Amazon.ForecastService.Model.S3Config requestDestination_destination_S3Config = null;
// populate S3Config
var requestDestination_destination_S3ConfigIsNull = true;
requestDestination_destination_S3Config = new Amazon.ForecastService.Model.S3Config();
System.String requestDestination_destination_S3Config_s3Config_KMSKeyArn = null;
if (cmdletContext.S3Config_KMSKeyArn != null)
{
requestDestination_destination_S3Config_s3Config_KMSKeyArn = cmdletContext.S3Config_KMSKeyArn;
}
if (requestDestination_destination_S3Config_s3Config_KMSKeyArn != null)
{
requestDestination_destination_S3Config.KMSKeyArn = requestDestination_destination_S3Config_s3Config_KMSKeyArn;
requestDestination_destination_S3ConfigIsNull = false;
}
System.String requestDestination_destination_S3Config_s3Config_Path = null;
if (cmdletContext.S3Config_Path != null)
{
requestDestination_destination_S3Config_s3Config_Path = cmdletContext.S3Config_Path;
}
if (requestDestination_destination_S3Config_s3Config_Path != null)
{
requestDestination_destination_S3Config.Path = requestDestination_destination_S3Config_s3Config_Path;
requestDestination_destination_S3ConfigIsNull = false;
}
System.String requestDestination_destination_S3Config_s3Config_RoleArn = null;
if (cmdletContext.S3Config_RoleArn != null)
{
requestDestination_destination_S3Config_s3Config_RoleArn = cmdletContext.S3Config_RoleArn;
}
if (requestDestination_destination_S3Config_s3Config_RoleArn != null)
{
requestDestination_destination_S3Config.RoleArn = requestDestination_destination_S3Config_s3Config_RoleArn;
requestDestination_destination_S3ConfigIsNull = false;
}
// determine if requestDestination_destination_S3Config should be set to null
if (requestDestination_destination_S3ConfigIsNull)
{
requestDestination_destination_S3Config = null;
}
if (requestDestination_destination_S3Config != null)
{
request.Destination.S3Config = requestDestination_destination_S3Config;
requestDestinationIsNull = false;
}
// determine if request.Destination should be set to null
if (requestDestinationIsNull)
{
request.Destination = null;
}
if (cmdletContext.ExplainabilityArn != null)
{
request.ExplainabilityArn = cmdletContext.ExplainabilityArn;
}
if (cmdletContext.ExplainabilityExportName != null)
{
request.ExplainabilityExportName = cmdletContext.ExplainabilityExportName;
}
if (cmdletContext.Format != null)
{
request.Format = cmdletContext.Format;
}
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.ForecastService.Model.CreateExplainabilityExportResponse CallAWSServiceOperation(IAmazonForecastService client, Amazon.ForecastService.Model.CreateExplainabilityExportRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Forecast Service", "CreateExplainabilityExport");
try
{
#if DESKTOP
return client.CreateExplainabilityExport(request);
#elif CORECLR
return client.CreateExplainabilityExportAsync(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 S3Config_KMSKeyArn { get; set; }
public System.String S3Config_Path { get; set; }
public System.String S3Config_RoleArn { get; set; }
public System.String ExplainabilityArn { get; set; }
public System.String ExplainabilityExportName { get; set; }
public System.String Format { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.ExplainabilityExportArn;
}
}
}