/*******************************************************************************
* 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.AWSSupport;
using Amazon.AWSSupport.Model;
namespace Amazon.PowerShell.Cmdlets.ASA
{
///
/// Returns a list of cases that you specify by passing one or more case IDs. You can
/// use the afterTime
and beforeTime
parameters to filter the
/// cases by date. You can set values for the includeResolvedCases
and includeCommunications
/// parameters to specify how much information to return.
///
///
///
/// The response returns the following in JSON format:
/// -
/// One or more CaseDetails
/// data types.
///
-
/// One or more
nextToken
values, which specify where to paginate the returned
/// records represented by the CaseDetails
objects.
///
/// Case data is available for 12 months after creation. If a case was created more than
/// 12 months ago, a request might return an error.
/// -
/// You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the
/// Amazon Web Services Support API.
///
-
/// If you call the Amazon Web Services Support API from an account that doesn't have
/// a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException
/// error message appears. For information about changing your support plan, see Amazon
/// Web Services Support.
///
This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.
///
[Cmdlet("Get", "ASACase")]
[OutputType("Amazon.AWSSupport.Model.CaseDetails")]
[AWSCmdlet("Calls the AWS Support DescribeCases API operation.", Operation = new[] {"DescribeCases"}, SelectReturnType = typeof(Amazon.AWSSupport.Model.DescribeCasesResponse), LegacyAlias="Get-ASACases")]
[AWSCmdletOutput("Amazon.AWSSupport.Model.CaseDetails or Amazon.AWSSupport.Model.DescribeCasesResponse",
"This cmdlet returns a collection of Amazon.AWSSupport.Model.CaseDetails objects.",
"The service call response (type Amazon.AWSSupport.Model.DescribeCasesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetASACaseCmdlet : AmazonAWSSupportClientCmdlet, IExecutor
{
#region Parameter AfterTime
///
///
/// The start date for a filtered date search on support case communications. Case communications
/// are available for 12 months after creation.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AfterTime { get; set; }
#endregion
#region Parameter BeforeTime
///
///
/// The end date for a filtered date search on support case communications. Case communications
/// are available for 12 months after creation.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String BeforeTime { get; set; }
#endregion
#region Parameter CaseIdList
///
///
/// A list of ID numbers of the support cases you want returned. The maximum number of
/// cases is 100.
///
///
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
public System.String[] CaseIdList { get; set; }
#endregion
#region Parameter DisplayId
///
///
/// The ID displayed for a case in the Amazon Web Services Support Center user interface.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DisplayId { get; set; }
#endregion
#region Parameter IncludeCommunication
///
///
/// Specifies whether to include communications in the DescribeCases
response.
/// By default, communications are included.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("IncludeCommunications")]
public System.Boolean? IncludeCommunication { get; set; }
#endregion
#region Parameter IncludeResolvedCase
///
///
/// Specifies whether to include resolved support cases in the DescribeCases
/// response. By default, resolved cases aren't included.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("IncludeResolvedCases")]
public System.Boolean? IncludeResolvedCase { get; set; }
#endregion
#region Parameter Language
///
///
/// The language in which Amazon Web Services Support handles the case. Amazon Web Services
/// Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean
/// (“ko”). You must specify the ISO 639-1 code for the language
parameter
/// if you want support in that language.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Language { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of results to return before paginating.
///
///
///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxItems","MaxResults")]
public int? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// A resumption point for pagination.
///
///
///
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
///
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Cases'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSSupport.Model.DescribeCasesResponse).
/// Specifying the name of a property of type Amazon.AWSSupport.Model.DescribeCasesResponse 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; } = "Cases";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the CaseIdList parameter.
/// The -PassThru parameter is deprecated, use -Select '^CaseIdList' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CaseIdList' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter NoAutoIteration
///
/// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple
/// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken
/// as the start point.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter NoAutoIteration { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
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.CaseIdList;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AfterTime = this.AfterTime;
context.BeforeTime = this.BeforeTime;
if (this.CaseIdList != null)
{
context.CaseIdList = new List(this.CaseIdList);
}
context.DisplayId = this.DisplayId;
context.IncludeCommunication = this.IncludeCommunication;
context.IncludeResolvedCase = this.IncludeResolvedCase;
context.Language = this.Language;
context.MaxResult = this.MaxResult;
#if !MODULAR
if (ParameterWasBound(nameof(this.MaxResult)) && this.MaxResult.HasValue)
{
WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxResult parameter to limit the total number of items returned by the cmdlet." +
" This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" +
" retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing MaxResult" +
" to the service to specify how many items should be returned by each service call.");
}
#endif
context.NextToken = this.NextToken;
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
#if MODULAR
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
// create request and set iteration invariants
var request = new Amazon.AWSSupport.Model.DescribeCasesRequest();
if (cmdletContext.AfterTime != null)
{
request.AfterTime = cmdletContext.AfterTime;
}
if (cmdletContext.BeforeTime != null)
{
request.BeforeTime = cmdletContext.BeforeTime;
}
if (cmdletContext.CaseIdList != null)
{
request.CaseIdList = cmdletContext.CaseIdList;
}
if (cmdletContext.DisplayId != null)
{
request.DisplayId = cmdletContext.DisplayId;
}
if (cmdletContext.IncludeCommunication != null)
{
request.IncludeCommunications = cmdletContext.IncludeCommunication.Value;
}
if (cmdletContext.IncludeResolvedCase != null)
{
request.IncludeResolvedCases = cmdletContext.IncludeResolvedCase.Value;
}
if (cmdletContext.Language != null)
{
request.Language = cmdletContext.Language;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.MaxResult.Value);
}
// Initialize loop variant and commence piping
var _nextToken = cmdletContext.NextToken;
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
_nextToken = response.NextToken;
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return null;
}
#else
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
// create request and set iteration invariants
var request = new Amazon.AWSSupport.Model.DescribeCasesRequest();
if (cmdletContext.AfterTime != null)
{
request.AfterTime = cmdletContext.AfterTime;
}
if (cmdletContext.BeforeTime != null)
{
request.BeforeTime = cmdletContext.BeforeTime;
}
if (cmdletContext.CaseIdList != null)
{
request.CaseIdList = cmdletContext.CaseIdList;
}
if (cmdletContext.DisplayId != null)
{
request.DisplayId = cmdletContext.DisplayId;
}
if (cmdletContext.IncludeCommunication != null)
{
request.IncludeCommunications = cmdletContext.IncludeCommunication.Value;
}
if (cmdletContext.IncludeResolvedCase != null)
{
request.IncludeResolvedCases = cmdletContext.IncludeResolvedCase.Value;
}
if (cmdletContext.Language != null)
{
request.Language = cmdletContext.Language;
}
// Initialize loop variants and commence piping
System.String _nextToken = null;
int? _emitLimit = null;
int _retrievedSoFar = 0;
if (AutoIterationHelpers.HasValue(cmdletContext.NextToken))
{
_nextToken = cmdletContext.NextToken;
}
if (cmdletContext.MaxResult.HasValue)
{
// The service has a maximum page size of 100. If the user has
// asked for more items than page max, and there is no page size
// configured, we rely on the service ignoring the set maximum
// and giving us 100 items back. If a page size is set, that will
// be used to configure the pagination.
// We'll make further calls to satisfy the user's request.
_emitLimit = cmdletContext.MaxResult;
}
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
if (_emitLimit.HasValue)
{
int correctPageSize = Math.Min(100, _emitLimit.Value);
request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToInt32(correctPageSize);
}
CmdletOutput output;
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
if (!useParameterSelect)
{
pipelineOutput = cmdletContext.Select(response, this);
}
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
int _receivedThisCall = response.Cases.Count;
_nextToken = response.NextToken;
_retrievedSoFar += _receivedThisCall;
if (_emitLimit.HasValue)
{
_emitLimit -= _receivedThisCall;
}
}
catch (Exception e)
{
if (_retrievedSoFar == 0 || !_emitLimit.HasValue)
{
output = new CmdletOutput { ErrorResponse = e };
}
else
{
break;
}
}
ProcessOutput(output);
} while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 10));
if (useParameterSelect)
{
WriteObject(cmdletContext.Select(null, this));
}
return null;
}
#endif
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.AWSSupport.Model.DescribeCasesResponse CallAWSServiceOperation(IAmazonAWSSupport client, Amazon.AWSSupport.Model.DescribeCasesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Support", "DescribeCases");
try
{
#if DESKTOP
return client.DescribeCases(request);
#elif CORECLR
return client.DescribeCasesAsync(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 AfterTime { get; set; }
public System.String BeforeTime { get; set; }
public List CaseIdList { get; set; }
public System.String DisplayId { get; set; }
public System.Boolean? IncludeCommunication { get; set; }
public System.Boolean? IncludeResolvedCase { get; set; }
public System.String Language { get; set; }
public int? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Cases;
}
}
}