list_closed_workflow_executions async ¶

async def list_closed_workflow_executions(
    self,
    domain: "capo_swf.types.domain_name.DomainName",
    *,
    config_overrides: Optional[AsyncSWFClientConfig] = None,
    start_time_filter: Optional[
        "capo_swf.types.execution_time_filter.ExecutionTimeFilter"
    ] = None,
    close_time_filter: Optional[
        "capo_swf.types.execution_time_filter.ExecutionTimeFilter"
    ] = None,
    execution_filter: Optional[
        "capo_swf.types.workflow_execution_filter.WorkflowExecutionFilter"
    ] = None,
    close_status_filter: Optional[
        "capo_swf.types.close_status_filter.CloseStatusFilter"
    ] = None,
    type_filter: Optional[
        "capo_swf.types.workflow_type_filter.WorkflowTypeFilter"
    ] = None,
    tag_filter: Optional["capo_swf.types.tag_filter.TagFilter"] = None,
    next_page_token: Optional["capo_swf.types.page_token.PageToken"] = None,
    maximum_page_size: Optional["capo_swf.types.page_size.PageSize"] = None,
    reverse_order: Optional["capo_swf.types.reverse_order.ReverseOrder"] = None,
) -> "capo_swf.types.workflow_execution_infos.WorkflowExecutionInfos":
    """<p>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.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.</p> </note> <p> <b>Access Control</b> </p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li> <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p> </li> <li> <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p> </li> <li> <p>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.</p> <ul> <li> <p> <code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</p> </li> <li> <p> <code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</p> </li> <li> <p> <code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</p> </li> </ul> </li> </ul> <p>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 <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>

    Args:
        domain: <p>The name of the domain that contains the workflow executions to list.</p>
        start_time_filter: <p>If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.</p> <note> <p> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> </note>
        close_time_filter: <p>If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.</p> <note> <p> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> </note>
        execution_filter: <p>If specified, only workflow executions matching the workflow ID specified in the filter are returned.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        close_status_filter: <p>If specified, only workflow executions that match this <i>close status</i> are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        type_filter: <p>If specified, only executions of the type specified in the filter are returned.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        tag_filter: <p>If specified, only executions that have the matching tag are listed.</p> <note> <p> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> </note>
        next_page_token: <p>If <code>NextPageToken</code> is returned there are more results available. The value of <code>NextPageToken</code> 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 24 hours. Using an expired pagination token will return a <code>400</code> error: "<code>Specified token has exceeded its maximum lifetime</code>". </p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. </p>
        maximum_page_size: <p>The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages of results. </p>
        reverse_order: <p>When set to <code>true</code>, 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.</p>

    Raises:
        capo_swf.errors.operation_not_permitted_fault.OperationNotPermittedFault: <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</p>
        capo_swf.errors.unknown_resource_fault.UnknownResourceFault: <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
        capo_swf.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_swf.types.list_closed_workflow_executions_input.ListClosedWorkflowExecutionsInput]",
    ) -> AsyncOperationResponse[
        "capo_swf.types.workflow_execution_infos.WorkflowExecutionInfos"
    ]:
        import capo_swf._operations.simple_workflow_service.list_closed_workflow_executions

        (
            output,
            http_response,
        ) = await capo_swf._operations.simple_workflow_service.list_closed_workflow_executions.async_list_closed_workflow_executions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListClosedWorkflowExecutions")
    )
    input_: capo_swf.types.list_closed_workflow_executions_input.ListClosedWorkflowExecutionsInput = {
        "domain": domain
    }
    if start_time_filter is not None:
        input_["start_time_filter"] = start_time_filter
    if close_time_filter is not None:
        input_["close_time_filter"] = close_time_filter
    if execution_filter is not None:
        input_["execution_filter"] = execution_filter
    if close_status_filter is not None:
        input_["close_status_filter"] = close_status_filter
    if type_filter is not None:
        input_["type_filter"] = type_filter
    if tag_filter is not None:
        input_["tag_filter"] = tag_filter
    if next_page_token is not None:
        input_["next_page_token"] = next_page_token
    if maximum_page_size is not None:
        input_["maximum_page_size"] = maximum_page_size
    if reverse_order is not None:
        input_["reverse_order"] = reverse_order

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output