ListOpenWorkflowExecutionsInput

public struct ListOpenWorkflowExecutionsInput : AWSShape
extension SWF.ListOpenWorkflowExecutionsInput: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The name of the domain that contains the workflow executions to list.

    Declaration

    Swift

    public let domain: String

  • If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    Declaration

    Swift

    public let executionFilter: WorkflowExecutionFilter?

  • The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    Declaration

    Swift

    public let maximumPageSize: Int?

  • 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.

    Declaration

    Swift

    public let nextPageToken: String?

  • When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

    Declaration

    Swift

    public let reverseOrder: Bool?

  • Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

    Declaration

    Swift

    public let startTimeFilter: ExecutionTimeFilter

  • If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    Declaration

    Swift

    public let tagFilter: TagFilter?

  • If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    Declaration

    Swift

    public let typeFilter: WorkflowTypeFilter?

  • Undocumented

    Declaration

    Swift

    public init(domain: String, executionFilter: WorkflowExecutionFilter? = nil, maximumPageSize: Int? = nil, nextPageToken: String? = nil, reverseOrder: Bool? = nil, startTimeFilter: ExecutionTimeFilter, tagFilter: TagFilter? = nil, typeFilter: WorkflowTypeFilter? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws

Paginators

  • Undocumented

    Declaration

    Swift

    public func usingPaginationToken(_ token: String) -> SWF.ListOpenWorkflowExecutionsInput