AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Simple Workflow Service (SWF) ListClosedWorkflowExecutions API operation.

Syntax

Get-SWFClosedWorkflowExecutionList
-Domain <String>
-CloseTimeFilter_LatestDate <DateTime>
-StartTimeFilter_LatestDate <DateTime>
-TypeFilter_Name <String>
-CloseTimeFilter_OldestDate <DateTime>
-StartTimeFilter_OldestDate <DateTime>
-ReverseOrder <Boolean>
-CloseStatusFilter_Status <CloseStatus>
-TagFilter_Tag <String>
-TypeFilter_Version <String>
-ExecutionFilter_WorkflowId <String>
-MaximumPageSize <Int32>
-NextPageToken <String>
-Select <String>
-PassThru <SwitchParameter>
-NoAutoIteration <SwitchParameter>

Description

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. 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.

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.

Parameters

-CloseStatusFilter_Status <CloseStatus>
The close status that must match the close status of an execution for it to meet the criteria of this filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloseTimeFilter_LatestDate <DateTime>
Specifies the latest start or close date and time to return.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloseTimeFilter_OldestDate <DateTime>
Specifies the oldest start or close date and time to return.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Domain <String>
The name of the domain that contains the workflow executions to list.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ExecutionFilter_WorkflowId <String>
The workflowId to pass of match the criteria of this filter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaximumPageSize <Int32>
The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems
-NextPageToken <String>
If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime". The configured maximumPageSize determines how many results can be returned in a single call.
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 '-NextPageToken $null' for the first call and '-NextPageToken $AWSHistory.LastServiceResponse.NextPageToken' for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNextToken
-NoAutoIteration <SwitchParameter>
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 NextPageToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReverseOrder <Boolean>
When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'WorkflowExecutionInfos.ExecutionInfos'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsResponse). Specifying the name of a property of type Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTimeFilter_LatestDate <DateTime>
Specifies the latest start or close date and time to return.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTimeFilter_OldestDate <DateTime>
Specifies the oldest start or close date and time to return.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagFilter_Tag <String>
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: _ . : / = + - @.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TypeFilter_Name <String>
Name of the workflow type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TypeFilter_Version <String>
Version of the workflow type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfileName, StoredCredentials
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases SecretAccessKey, SK
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)

Inputs

System.String
You can pipe a String object to this cmdlet for the Domain parameter.

Outputs

Amazon.SimpleWorkflow.Model.WorkflowExecutionInfo or Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsResponse
This cmdlet returns a collection of Amazon.SimpleWorkflow.Model.WorkflowExecutionInfo objects. The service call response (type Amazon.SimpleWorkflow.Model.ListClosedWorkflowExecutionsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z