/*******************************************************************************
* 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.Chime;
using Amazon.Chime.Model;
namespace Amazon.PowerShell.Cmdlets.CHM
{
///
/// Searches for phone numbers that can be ordered. For US numbers, provide at least one
/// of the following search filters: AreaCode
, City
, State
,
/// or TollFreePrefix
. If you provide City
, you must also provide
/// State
. Numbers outside the US only support the PhoneNumberType
/// filter, which you must use.
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("Search", "CHMAvailablePhoneNumber", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon Chime SearchAvailablePhoneNumbers API operation.", Operation = new[] {"SearchAvailablePhoneNumbers"}, SelectReturnType = typeof(Amazon.Chime.Model.SearchAvailablePhoneNumbersResponse))]
[AWSCmdletOutput("System.String or Amazon.Chime.Model.SearchAvailablePhoneNumbersResponse",
"This cmdlet returns a collection of System.String objects.",
"The service call response (type Amazon.Chime.Model.SearchAvailablePhoneNumbersResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SearchCHMAvailablePhoneNumberCmdlet : AmazonChimeClientCmdlet, IExecutor
{
#region Parameter AreaCode
///
///
/// The area code used to filter results. Only applies to the US.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AreaCode { get; set; }
#endregion
#region Parameter City
///
///
/// The city used to filter results. Only applies to the US.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String City { get; set; }
#endregion
#region Parameter Country
///
///
/// The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Country { get; set; }
#endregion
#region Parameter PhoneNumberType
///
///
/// The phone number type used to filter results. Required for non-US numbers.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Chime.PhoneNumberType")]
public Amazon.Chime.PhoneNumberType PhoneNumberType { get; set; }
#endregion
#region Parameter State
///
///
/// The state used to filter results. Required only if you provide City
.
/// Only applies to the US.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String State { get; set; }
#endregion
#region Parameter TollFreePrefix
///
///
/// The toll-free prefix that you use to filter results. Only applies to the US.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TollFreePrefix { get; set; }
#endregion
#region Parameter MaxResult
///
///
/// The maximum number of results to return in a single call.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// The token used to retrieve the next page of results.
///
///
///
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 'E164PhoneNumbers'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Chime.Model.SearchAvailablePhoneNumbersResponse).
/// Specifying the name of a property of type Amazon.Chime.Model.SearchAvailablePhoneNumbersResponse 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; } = "E164PhoneNumbers";
#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
#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 resourceIdentifiersText = string.Empty;
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Search-CHMAvailablePhoneNumber (SearchAvailablePhoneNumbers)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.AreaCode = this.AreaCode;
context.City = this.City;
context.Country = this.Country;
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
context.PhoneNumberType = this.PhoneNumberType;
context.State = this.State;
context.TollFreePrefix = this.TollFreePrefix;
// 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;
var useParameterSelect = this.Select.StartsWith("^");
// create request and set iteration invariants
var request = new Amazon.Chime.Model.SearchAvailablePhoneNumbersRequest();
if (cmdletContext.AreaCode != null)
{
request.AreaCode = cmdletContext.AreaCode;
}
if (cmdletContext.City != null)
{
request.City = cmdletContext.City;
}
if (cmdletContext.Country != null)
{
request.Country = cmdletContext.Country;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.PhoneNumberType != null)
{
request.PhoneNumberType = cmdletContext.PhoneNumberType;
}
if (cmdletContext.State != null)
{
request.State = cmdletContext.State;
}
if (cmdletContext.TollFreePrefix != null)
{
request.TollFreePrefix = cmdletContext.TollFreePrefix;
}
// 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;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.Chime.Model.SearchAvailablePhoneNumbersResponse CallAWSServiceOperation(IAmazonChime client, Amazon.Chime.Model.SearchAvailablePhoneNumbersRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Chime", "SearchAvailablePhoneNumbers");
try
{
#if DESKTOP
return client.SearchAvailablePhoneNumbers(request);
#elif CORECLR
return client.SearchAvailablePhoneNumbersAsync(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 AreaCode { get; set; }
public System.String City { get; set; }
public System.String Country { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public Amazon.Chime.PhoneNumberType PhoneNumberType { get; set; }
public System.String State { get; set; }
public System.String TollFreePrefix { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.E164PhoneNumbers;
}
}
}