Synopsis
Calls the AWS Simple Workflow Service 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>
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:
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
- Use a
Resourceelement with the domain name to limit the action to only specified domains. - Use an
Actionelement to allow or deny permission to call this action. - Constrain the following parameters by using a
Conditionelement with the appropriate keys.tagFilter.tag: String constraint. The key isswf:tagFilter.tag.typeFilter.name: String constraint. The key isswf:typeFilter.name.typeFilter.version: String constraint. The key isswf:typeFilter.version.
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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
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? | False |
-CloseTimeFilter_LatestDate <DateTime>
Specifies the latest start or close date and time to return.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-CloseTimeFilter_OldestDate <DateTime>
Specifies the oldest start or close date and time to return.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Domain <String>
The name of the domain that contains the workflow executions to list.
| Required? | False |
| 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? | False |
-MaximumPageSize <Int32>
The maximum number of results that are returned per call. Use
nextPageToken to obtain further pages of results. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | MaxItems |
-NextPageToken <String>
If
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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter.
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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextPageToken, for subsequent calls, to this parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | NextToken |
-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? | False |
-StartTimeFilter_LatestDate <DateTime>
Specifies the latest start or close date and time to return.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-StartTimeFilter_OldestDate <DateTime>
Specifies the oldest start or close date and time to return.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-TypeFilter_Name <String>
Name of the workflow type.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-TypeFilter_Version <String>
Version of the workflow type.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
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? | False |
-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? | False |
-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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
-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? | False |
Inputs
You can pipe a String object to this cmdlet for the Domain parameter.
Outputs
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.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextPageToken (type System.String)
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
