/******************************************************************************* * 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.Pinpoint; using Amazon.Pinpoint.Model; namespace Amazon.PowerShell.Cmdlets.PIN { /// /// Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. /// [Cmdlet("Get", "PINCampaignDateRangeKpi")] [OutputType("Amazon.Pinpoint.Model.CampaignDateRangeKpiResponse")] [AWSCmdlet("Calls the Amazon Pinpoint GetCampaignDateRangeKpi API operation.", Operation = new[] {"GetCampaignDateRangeKpi"}, SelectReturnType = typeof(Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse))] [AWSCmdletOutput("Amazon.Pinpoint.Model.CampaignDateRangeKpiResponse or Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse", "This cmdlet returns an Amazon.Pinpoint.Model.CampaignDateRangeKpiResponse object.", "The service call response (type Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetPINCampaignDateRangeKpiCmdlet : AmazonPinpointClientCmdlet, IExecutor { #region Parameter ApplicationId /// /// /// The unique identifier for the application. This identifier is displayed as the Project /// ID on the Amazon Pinpoint console. /// /// #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 ApplicationId { get; set; } #endregion #region Parameter CampaignId /// /// /// The unique identifier for the campaign. /// /// #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 CampaignId { get; set; } #endregion #region Parameter EndTime /// /// /// The last date and time to retrieve data for, as part of an inclusive date range that /// filters the query results. This value should be in extended ISO 8601 format and use /// Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC /// July 26, 2019. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? EndTime { get; set; } #endregion #region Parameter KpiName /// /// /// The name of the metric, also referred to as a key performance indicator (KPI), /// to retrieve data for. This value describes the associated metric and consists of two /// or more terms, which are comprised of lowercase alphanumeric characters, separated /// by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list /// of valid values, see the Amazon /// Pinpoint Developer Guide. /// /// #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 KpiName { get; set; } #endregion #region Parameter StartTime /// /// /// The first date and time to retrieve data for, as part of an inclusive date range that /// filters the query results. This value should be in extended ISO 8601 format and use /// Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC /// July 19, 2019. This value should also be fewer than 90 days from the current day. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.DateTime? StartTime { get; set; } #endregion #region Parameter NextToken /// /// /// The string that specifies which page of results to return in a paginated response. /// This parameter is not supported for application, campaign, and journey metrics. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { get; set; } #endregion #region Parameter PageSize /// /// /// The maximum number of items to include in each page of a paginated response. This /// parameter is not supported for application, campaign, and journey metrics. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PageSize { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'CampaignDateRangeKpiResponse'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse). /// Specifying the name of a property of type Amazon.Pinpoint.Model.GetCampaignDateRangeKpiResponse 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; } = "CampaignDateRangeKpiResponse"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. /// The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ApplicationId' 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.ApplicationId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ApplicationId = this.ApplicationId; #if MODULAR if (this.ApplicationId == null && ParameterWasBound(nameof(this.ApplicationId))) { WriteWarning("You are passing $null as a value for parameter ApplicationId 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.CampaignId = this.CampaignId; #if MODULAR if (this.CampaignId == null && ParameterWasBound(nameof(this.CampaignId))) { WriteWarning("You are passing $null as a value for parameter CampaignId 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.EndTime = this.EndTime; context.KpiName = this.KpiName; #if MODULAR if (this.KpiName == null && ParameterWasBound(nameof(this.KpiName))) { WriteWarning("You are passing $null as a value for parameter KpiName 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.NextToken = this.NextToken; context.PageSize = this.PageSize; context.StartTime = this.StartTime; // 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.Pinpoint.Model.GetCampaignDateRangeKpiRequest(); if (cmdletContext.ApplicationId != null) { request.ApplicationId = cmdletContext.ApplicationId; } if (cmdletContext.CampaignId != null) { request.CampaignId = cmdletContext.CampaignId; } if (cmdletContext.EndTime != null) { request.EndTime = cmdletContext.EndTime.Value; } if (cmdletContext.KpiName != null) { request.KpiName = cmdletContext.KpiName; } if (cmdletContext.NextToken != null) { request.NextToken = cmdletContext.NextToken; } if (cmdletContext.PageSize != null) { request.PageSize = cmdletContext.PageSize; } if (cmdletContext.StartTime != null) { request.StartTime = cmdletContext.StartTime.Value; } 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.Pinpoint.Model.GetCampaignDateRangeKpiResponse CallAWSServiceOperation(IAmazonPinpoint client, Amazon.Pinpoint.Model.GetCampaignDateRangeKpiRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Pinpoint", "GetCampaignDateRangeKpi"); try { #if DESKTOP return client.GetCampaignDateRangeKpi(request); #elif CORECLR return client.GetCampaignDateRangeKpiAsync(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 ApplicationId { get; set; } public System.String CampaignId { get; set; } public System.DateTime? EndTime { get; set; } public System.String KpiName { get; set; } public System.String NextToken { get; set; } public System.String PageSize { get; set; } public System.DateTime? StartTime { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.CampaignDateRangeKpiResponse; } } }