/*******************************************************************************
* 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.EC2;
using Amazon.EC2.Model;
namespace Amazon.PowerShell.Cmdlets.EC2
{
///
/// Submits feedback about the status of an instance. The instance must be in the running
/// state. If your experience with the instance differs from the instance status returned
/// by DescribeInstanceStatus, use ReportInstanceStatus to report your experience
/// with the instance. Amazon EC2 collects this information to improve the accuracy of
/// status checks.
///
///
///
/// Use of this action does not change the value returned by DescribeInstanceStatus.
///
///
[Cmdlet("Send", "EC2InstanceStatus", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon Elastic Compute Cloud (EC2) ReportInstanceStatus API operation.", Operation = new[] {"ReportInstanceStatus"}, SelectReturnType = typeof(Amazon.EC2.Model.ReportInstanceStatusResponse))]
[AWSCmdletOutput("None or Amazon.EC2.Model.ReportInstanceStatusResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.EC2.Model.ReportInstanceStatusResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SendEC2InstanceStatusCmdlet : AmazonEC2ClientCmdlet, IExecutor
{
#region Parameter Description
///
///
/// Descriptive text about the health state of your instance.
///
///
[System.Management.Automation.Parameter(Position = 4, ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter UtcEndTime
///
///
/// The time at which the reported instance health state ended.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? UtcEndTime { get; set; }
#endregion
#region Parameter Instance
///
///
/// The instances.
///
///
#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.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("InstanceId","Instances")]
public System.String[] Instance { get; set; }
#endregion
#region Parameter ReasonCode
///
///
/// The reason codes that describe the health state of your instance.instance-stuck-in-state
: My instance is stuck in a state.unresponsive
: My instance is unresponsive.not-accepting-credentials
: My instance is not accepting my credentials.password-not-available
: A password is not available for my instance.performance-network
: My instance is experiencing performance problems
/// that I believe are network related.performance-instance-store
: My instance is experiencing performance
/// problems that I believe are related to the instance stores.performance-ebs-volume
: My instance is experiencing performance problems
/// that I believe are related to an EBS volume.performance-other
: My instance is experiencing performance problems.other
: [explain using the description parameter]
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(Position = 3, ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("ReasonCodes")]
public System.String[] ReasonCode { get; set; }
#endregion
#region Parameter UtcStartTime
///
///
/// The time at which the reported instance health state began.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? UtcStartTime { get; set; }
#endregion
#region Parameter Status
///
///
/// The status of all instances listed.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.EC2.ReportStatusType")]
public Amazon.EC2.ReportStatusType Status { get; set; }
#endregion
#region Parameter EndTime
///
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc
/// results in both EndTime and EndTimeUtc being assigned, the latest assignment to either
/// one of the two property is reflected in the value of both. EndTime is provided for
/// backwards compatibility only and assigning a non-Utc DateTime to it results in the
/// wrong timestamp being passed to the service.The time at which the reported instance health state ended.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(Position = 2, ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcEndTime instead.")]
public System.DateTime? EndTime { get; set; }
#endregion
#region Parameter StartTime
///
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or
/// StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest
/// assignment to either one of the two property is reflected in the value of both. StartTime
/// is provided for backwards compatibility only and assigning a non-Utc DateTime to it
/// results in the wrong timestamp being passed to the service.The time at which the reported instance health state began.
///
/// This parameter is deprecated.
///
[System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
[System.ObsoleteAttribute("This parameter is deprecated and may result in the wrong timestamp being passed to the service, use UtcStartTime instead.")]
public System.DateTime? StartTime { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ReportInstanceStatusResponse).
/// 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 Instance parameter.
/// The -PassThru parameter is deprecated, use -Select '^Instance' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Instance' 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.Instance), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Send-EC2InstanceStatus (ReportInstanceStatus)"))
{
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.Instance;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Description = this.Description;
context.UtcEndTime = this.UtcEndTime;
if (this.Instance != null)
{
context.Instance = new List(this.Instance);
}
#if MODULAR
if (this.Instance == null && ParameterWasBound(nameof(this.Instance)))
{
WriteWarning("You are passing $null as a value for parameter Instance 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.ReasonCode != null)
{
context.ReasonCode = new List(this.ReasonCode);
}
#if MODULAR
if (this.ReasonCode == null && ParameterWasBound(nameof(this.ReasonCode)))
{
WriteWarning("You are passing $null as a value for parameter ReasonCode 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.UtcStartTime = this.UtcStartTime;
context.Status = this.Status;
#if MODULAR
if (this.Status == null && ParameterWasBound(nameof(this.Status)))
{
WriteWarning("You are passing $null as a value for parameter Status 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
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.EndTime = this.EndTime;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.StartTime = this.StartTime;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// 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.EC2.Model.ReportInstanceStatusRequest();
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.UtcEndTime != null)
{
request.EndTimeUtc = cmdletContext.UtcEndTime.Value;
}
if (cmdletContext.Instance != null)
{
request.Instances = cmdletContext.Instance;
}
if (cmdletContext.ReasonCode != null)
{
request.ReasonCodes = cmdletContext.ReasonCode;
}
if (cmdletContext.UtcStartTime != null)
{
request.StartTimeUtc = cmdletContext.UtcStartTime.Value;
}
if (cmdletContext.Status != null)
{
request.Status = cmdletContext.Status;
}
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.EndTime != null)
{
if (cmdletContext.UtcEndTime != null)
{
throw new System.ArgumentException("Parameters EndTime and UtcEndTime are mutually exclusive.", nameof(this.EndTime));
}
request.EndTime = cmdletContext.EndTime.Value;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (cmdletContext.StartTime != null)
{
if (cmdletContext.UtcStartTime != null)
{
throw new System.ArgumentException("Parameters StartTime and UtcStartTime are mutually exclusive.", nameof(this.StartTime));
}
request.StartTime = cmdletContext.StartTime.Value;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
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.EC2.Model.ReportInstanceStatusResponse CallAWSServiceOperation(IAmazonEC2 client, Amazon.EC2.Model.ReportInstanceStatusRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Compute Cloud (EC2)", "ReportInstanceStatus");
try
{
#if DESKTOP
return client.ReportInstanceStatus(request);
#elif CORECLR
return client.ReportInstanceStatusAsync(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 Description { get; set; }
public System.DateTime? UtcEndTime { get; set; }
public List Instance { get; set; }
public List ReasonCode { get; set; }
public System.DateTime? UtcStartTime { get; set; }
public Amazon.EC2.ReportStatusType Status { get; set; }
[System.ObsoleteAttribute]
public System.DateTime? EndTime { get; set; }
[System.ObsoleteAttribute]
public System.DateTime? StartTime { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}