/*******************************************************************************
* 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.SimpleWorkflow;
using Amazon.SimpleWorkflow.Model;
namespace Amazon.PowerShell.Cmdlets.SWF
{
///
/// Returns the number of open workflow executions within the given domain that meet the
/// specified filtering criteria.
///
///
/// This operation is eventually consistent. The results are best effort and may not exactly
/// reflect recent updates and changes.
/// Access Control
/// You can use IAM policies to control this action's access to Amazon SWF resources as
/// follows:
/// -
/// Use a
Resource
element with the domain name to limit the action to only
/// specified domains.
/// -
/// Use an
Action
element to allow or deny permission to call this action.
/// -
/// Constrain the following parameters by using a
Condition
element with
/// the appropriate keys.
/// tagFilter.tag
: String constraint. The key is swf:tagFilter.tag
.
/// typeFilter.name
: String constraint. The key is swf:typeFilter.name
.
/// typeFilter.version
: String constraint. The key is swf:typeFilter.version
.
///
/// If the caller doesn't have sufficient permissions to invoke the action, or the parameter
/// values fall outside the specified constraints, the action fails. The associated event
/// attribute's cause
parameter is set to OPERATION_NOT_PERMITTED
.
/// For details and example IAM policies, see Using
/// IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
///
///
[Cmdlet("Get", "SWFOpenWorkflowExecutionCount")]
[OutputType("Amazon.SimpleWorkflow.Model.WorkflowExecutionCount")]
[AWSCmdlet("Calls the AWS Simple Workflow Service (SWF) CountOpenWorkflowExecutions API operation.", Operation = new[] {"CountOpenWorkflowExecutions"}, SelectReturnType = typeof(Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsResponse))]
[AWSCmdletOutput("Amazon.SimpleWorkflow.Model.WorkflowExecutionCount or Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsResponse",
"This cmdlet returns an Amazon.SimpleWorkflow.Model.WorkflowExecutionCount object.",
"The service call response (type Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetSWFOpenWorkflowExecutionCountCmdlet : AmazonSimpleWorkflowClientCmdlet, IExecutor
{
#region Parameter Domain
///
///
/// The name of the domain containing the workflow executions to count.
///
///
#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 Domain { get; set; }
#endregion
#region Parameter StartTimeFilter_LatestDate
///
///
/// Specifies the latest start or close date and time to return.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? StartTimeFilter_LatestDate { get; set; }
#endregion
#region Parameter TypeFilter_Name
///
///
/// Name of the workflow type.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TypeFilter_Name { get; set; }
#endregion
#region Parameter StartTimeFilter_OldestDate
///
///
/// Specifies the oldest start or close date and time to return.
///
///
#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]
public System.DateTime? StartTimeFilter_OldestDate { get; set; }
#endregion
#region Parameter TagFilter_Tag
///
///
/// Specifies the tag that must be associated with the execution for it to meet the filter
/// criteria.Tags may only contain unicode letters, digits, whitespace, or these symbols: _
/// . : / = + - @
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TagFilter_Tag { get; set; }
#endregion
#region Parameter TypeFilter_Version
///
///
/// Version of the workflow type.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TypeFilter_Version { get; set; }
#endregion
#region Parameter ExecutionFilter_WorkflowId
///
///
/// The workflowId to pass of match the criteria of this filter.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ExecutionFilter_WorkflowId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowExecutionCount'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsResponse).
/// Specifying the name of a property of type Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsResponse 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; } = "WorkflowExecutionCount";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the Domain parameter.
/// The -PassThru parameter is deprecated, use -Select '^Domain' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Domain' 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.Domain;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Domain = this.Domain;
#if MODULAR
if (this.Domain == null && ParameterWasBound(nameof(this.Domain)))
{
WriteWarning("You are passing $null as a value for parameter Domain 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.ExecutionFilter_WorkflowId = this.ExecutionFilter_WorkflowId;
context.StartTimeFilter_LatestDate = this.StartTimeFilter_LatestDate;
context.StartTimeFilter_OldestDate = this.StartTimeFilter_OldestDate;
#if MODULAR
if (this.StartTimeFilter_OldestDate == null && ParameterWasBound(nameof(this.StartTimeFilter_OldestDate)))
{
WriteWarning("You are passing $null as a value for parameter StartTimeFilter_OldestDate 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.TagFilter_Tag = this.TagFilter_Tag;
context.TypeFilter_Name = this.TypeFilter_Name;
context.TypeFilter_Version = this.TypeFilter_Version;
// 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.SimpleWorkflow.Model.CountOpenWorkflowExecutionsRequest();
if (cmdletContext.Domain != null)
{
request.Domain = cmdletContext.Domain;
}
// populate ExecutionFilter
var requestExecutionFilterIsNull = true;
request.ExecutionFilter = new Amazon.SimpleWorkflow.Model.WorkflowExecutionFilter();
System.String requestExecutionFilter_executionFilter_WorkflowId = null;
if (cmdletContext.ExecutionFilter_WorkflowId != null)
{
requestExecutionFilter_executionFilter_WorkflowId = cmdletContext.ExecutionFilter_WorkflowId;
}
if (requestExecutionFilter_executionFilter_WorkflowId != null)
{
request.ExecutionFilter.WorkflowId = requestExecutionFilter_executionFilter_WorkflowId;
requestExecutionFilterIsNull = false;
}
// determine if request.ExecutionFilter should be set to null
if (requestExecutionFilterIsNull)
{
request.ExecutionFilter = null;
}
// populate StartTimeFilter
var requestStartTimeFilterIsNull = true;
request.StartTimeFilter = new Amazon.SimpleWorkflow.Model.ExecutionTimeFilter();
System.DateTime? requestStartTimeFilter_startTimeFilter_LatestDate = null;
if (cmdletContext.StartTimeFilter_LatestDate != null)
{
requestStartTimeFilter_startTimeFilter_LatestDate = cmdletContext.StartTimeFilter_LatestDate.Value;
}
if (requestStartTimeFilter_startTimeFilter_LatestDate != null)
{
request.StartTimeFilter.LatestDate = requestStartTimeFilter_startTimeFilter_LatestDate.Value;
requestStartTimeFilterIsNull = false;
}
System.DateTime? requestStartTimeFilter_startTimeFilter_OldestDate = null;
if (cmdletContext.StartTimeFilter_OldestDate != null)
{
requestStartTimeFilter_startTimeFilter_OldestDate = cmdletContext.StartTimeFilter_OldestDate.Value;
}
if (requestStartTimeFilter_startTimeFilter_OldestDate != null)
{
request.StartTimeFilter.OldestDate = requestStartTimeFilter_startTimeFilter_OldestDate.Value;
requestStartTimeFilterIsNull = false;
}
// determine if request.StartTimeFilter should be set to null
if (requestStartTimeFilterIsNull)
{
request.StartTimeFilter = null;
}
// populate TagFilter
var requestTagFilterIsNull = true;
request.TagFilter = new Amazon.SimpleWorkflow.Model.TagFilter();
System.String requestTagFilter_tagFilter_Tag = null;
if (cmdletContext.TagFilter_Tag != null)
{
requestTagFilter_tagFilter_Tag = cmdletContext.TagFilter_Tag;
}
if (requestTagFilter_tagFilter_Tag != null)
{
request.TagFilter.Tag = requestTagFilter_tagFilter_Tag;
requestTagFilterIsNull = false;
}
// determine if request.TagFilter should be set to null
if (requestTagFilterIsNull)
{
request.TagFilter = null;
}
// populate TypeFilter
var requestTypeFilterIsNull = true;
request.TypeFilter = new Amazon.SimpleWorkflow.Model.WorkflowTypeFilter();
System.String requestTypeFilter_typeFilter_Name = null;
if (cmdletContext.TypeFilter_Name != null)
{
requestTypeFilter_typeFilter_Name = cmdletContext.TypeFilter_Name;
}
if (requestTypeFilter_typeFilter_Name != null)
{
request.TypeFilter.Name = requestTypeFilter_typeFilter_Name;
requestTypeFilterIsNull = false;
}
System.String requestTypeFilter_typeFilter_Version = null;
if (cmdletContext.TypeFilter_Version != null)
{
requestTypeFilter_typeFilter_Version = cmdletContext.TypeFilter_Version;
}
if (requestTypeFilter_typeFilter_Version != null)
{
request.TypeFilter.Version = requestTypeFilter_typeFilter_Version;
requestTypeFilterIsNull = false;
}
// determine if request.TypeFilter should be set to null
if (requestTypeFilterIsNull)
{
request.TypeFilter = null;
}
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.SimpleWorkflow.Model.CountOpenWorkflowExecutionsResponse CallAWSServiceOperation(IAmazonSimpleWorkflow client, Amazon.SimpleWorkflow.Model.CountOpenWorkflowExecutionsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Simple Workflow Service (SWF)", "CountOpenWorkflowExecutions");
try
{
#if DESKTOP
return client.CountOpenWorkflowExecutions(request);
#elif CORECLR
return client.CountOpenWorkflowExecutionsAsync(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 Domain { get; set; }
public System.String ExecutionFilter_WorkflowId { get; set; }
public System.DateTime? StartTimeFilter_LatestDate { get; set; }
public System.DateTime? StartTimeFilter_OldestDate { get; set; }
public System.String TagFilter_Tag { get; set; }
public System.String TypeFilter_Name { get; set; }
public System.String TypeFilter_Version { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.WorkflowExecutionCount;
}
}
}