/******************************************************************************* * 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.LocationService; using Amazon.LocationService.Model; namespace Amazon.PowerShell.Cmdlets.LOC { /// /// Finds a place by its unique ID. A PlaceId is returned by other search /// operations. /// /// /// A PlaceId is valid only if all of the following are the same in the original search /// request and the call to GetPlace. /// /// [Cmdlet("Get", "LOCPlace")] [OutputType("Amazon.LocationService.Model.Place")] [AWSCmdlet("Calls the Amazon Location Service GetPlace API operation.", Operation = new[] {"GetPlace"}, SelectReturnType = typeof(Amazon.LocationService.Model.GetPlaceResponse))] [AWSCmdletOutput("Amazon.LocationService.Model.Place or Amazon.LocationService.Model.GetPlaceResponse", "This cmdlet returns an Amazon.LocationService.Model.Place object.", "The service call response (type Amazon.LocationService.Model.GetPlaceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetLOCPlaceCmdlet : AmazonLocationServiceClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter IndexName /// /// /// The name of the place index resource that you want to use for the search. /// /// #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 IndexName { get; set; } #endregion #region Parameter Key /// /// /// The optional API /// key to authorize the request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Key { get; set; } #endregion #region Parameter Language /// /// /// The preferred language used to return results. The value must be a valid BCP /// 47 language tag, for example, en for English.This setting affects the languages used in the results, but not the results themselves. /// If no language is specified, or not supported for a particular result, the partner /// automatically chooses a language for the result.For an example, we'll use the Greek language. You search for a location around Athens, /// Greece, with the language parameter set to en. The city /// in the results will most likely be returned as Athens.If you set the language parameter to el, for Greek, then /// the city in the results will more likely be returned as Αθήνα.If the data provider does not have a value for Greek, the result will be in a language /// that the provider does support. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Language { get; set; } #endregion #region Parameter PlaceId /// /// /// The identifier of the place to find. /// /// #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 PlaceId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Place'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.GetPlaceResponse). /// Specifying the name of a property of type Amazon.LocationService.Model.GetPlaceResponse 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; } = "Place"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the IndexName parameter. /// The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { 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.IndexName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.IndexName = this.IndexName; #if MODULAR if (this.IndexName == null && ParameterWasBound(nameof(this.IndexName))) { WriteWarning("You are passing $null as a value for parameter IndexName 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.Key = this.Key; context.Language = this.Language; context.PlaceId = this.PlaceId; #if MODULAR if (this.PlaceId == null && ParameterWasBound(nameof(this.PlaceId))) { WriteWarning("You are passing $null as a value for parameter PlaceId 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 // 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.LocationService.Model.GetPlaceRequest(); if (cmdletContext.IndexName != null) { request.IndexName = cmdletContext.IndexName; } if (cmdletContext.Key != null) { request.Key = cmdletContext.Key; } if (cmdletContext.Language != null) { request.Language = cmdletContext.Language; } if (cmdletContext.PlaceId != null) { request.PlaceId = cmdletContext.PlaceId; } 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.LocationService.Model.GetPlaceResponse CallAWSServiceOperation(IAmazonLocationService client, Amazon.LocationService.Model.GetPlaceRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Location Service", "GetPlace"); try { #if DESKTOP return client.GetPlace(request); #elif CORECLR return client.GetPlaceAsync(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 IndexName { get; set; } public System.String Key { get; set; } public System.String Language { get; set; } public System.String PlaceId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Place; } } }