Skip to content

list_durable_executions_by_function async

list_durable_executions_by_function(
    function_name: NamespacedFunctionName,
    *,
    config_overrides: Optional[AsyncLambdaClientConfig] = None,
    qualifier: Optional[NumericLatestPublishedOrAliasQualifier] = None,
    durable_execution_name: Optional[DurableExecutionName] = None,
    statuses: Optional[ExecutionStatusList] = None,
    started_after: Optional[ExecutionTimestamp] = None,
    started_before: Optional[ExecutionTimestamp] = None,
    reverse_order: Optional[ReverseOrder] = None,
    marker: Optional[String] = None,
    max_items: Optional[ItemCount] = None,
) -> ListDurableExecutionsByFunctionResponse

Returns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.

Parameters:

  • function_name (NamespacedFunctionName) –

    The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.

  • qualifier (Optional[NumericLatestPublishedOrAliasQualifier], default: None ) –

    The function version to filter executions by. If you don't specify a qualifier, this operation returns executions across all versions of the Lambda function.

  • durable_execution_name (Optional[DurableExecutionName], default: None ) –

    Filter executions by name. Only executions with names that matches this string are returned.

  • statuses (Optional[ExecutionStatusList], default: None ) –

    Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

  • started_after (Optional[ExecutionTimestamp], default: None ) –

    Filter executions that started after this timestamp (ISO 8601 format).

  • started_before (Optional[ExecutionTimestamp], default: None ) –

    Filter executions that started before this timestamp (ISO 8601 format).

  • reverse_order (Optional[ReverseOrder], default: None ) –

    Set to true to return results in chronological order (oldest first). Default is false.

  • marker (Optional[String], default: None ) –

    Pagination token from a previous request to continue retrieving results.

  • max_items (Optional[ItemCount], default: None ) –

    Maximum number of executions to return (1-1000). Default is 100.

Raises:

Source code in docs_src/capo_lambda/_services/async__lambda.py
async def list_durable_executions_by_function(
    self,
    function_name: "capo_lambda.types.namespaced_function_name.NamespacedFunctionName",
    *,
    config_overrides: Optional[AsyncLambdaClientConfig] = None,
    qualifier: Optional[
        "capo_lambda.types.numeric_latest_published_or_alias_qualifier.NumericLatestPublishedOrAliasQualifier"
    ] = None,
    durable_execution_name: Optional[
        "capo_lambda.types.durable_execution_name.DurableExecutionName"
    ] = None,
    statuses: Optional[
        "capo_lambda.types.execution_status_list.ExecutionStatusList"
    ] = None,
    started_after: Optional[
        "capo_lambda.types.execution_timestamp.ExecutionTimestamp"
    ] = None,
    started_before: Optional[
        "capo_lambda.types.execution_timestamp.ExecutionTimestamp"
    ] = None,
    reverse_order: Optional["capo_lambda.types.reverse_order.ReverseOrder"] = None,
    marker: Optional["capo_lambda.types.string.String"] = None,
    max_items: Optional["capo_lambda.types.item_count.ItemCount"] = None,
) -> "capo_lambda.types.list_durable_executions_by_function_response.ListDurableExecutionsByFunctionResponse":
    """<p>Returns a list of <a href="https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html">durable executions</a> for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.</p>

    Args:
        function_name: <p>The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.</p>
        qualifier: <p>The function version to filter executions by. If you don't specify a qualifier, this operation returns executions across all versions of the Lambda function.</p>
        durable_execution_name: <p>Filter executions by name. Only executions with names that matches this string are returned.</p>
        statuses: <p>Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.</p>
        started_after: <p>Filter executions that started after this timestamp (ISO 8601 format).</p>
        started_before: <p>Filter executions that started before this timestamp (ISO 8601 format).</p>
        reverse_order: <p>Set to true to return results in chronological order (oldest first). Default is false.</p>
        marker: <p>Pagination token from a previous request to continue retrieving results.</p>
        max_items: <p>Maximum number of executions to return (1-1000). Default is 100.</p>

    Raises:
        capo_lambda.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One of the parameters in the request is not valid.</p>
        capo_lambda.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request does not exist.</p>
        capo_lambda.errors.service_exception.ServiceException: <p>The Lambda service encountered an internal error.</p>
        capo_lambda.errors.too_many_requests_exception.TooManyRequestsException: <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p>
        capo_lambda.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lambda.types.list_durable_executions_by_function_request.ListDurableExecutionsByFunctionRequest]",
    ) -> AsyncOperationResponse[
        "capo_lambda.types.list_durable_executions_by_function_response.ListDurableExecutionsByFunctionResponse"
    ]:
        import capo_lambda._operations.aws_gir_api_service.list_durable_executions_by_function

        (
            output,
            http_response,
        ) = await capo_lambda._operations.aws_gir_api_service.list_durable_executions_by_function.async_list_durable_executions_by_function(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDurableExecutionsByFunction")
    )
    input_: capo_lambda.types.list_durable_executions_by_function_request.ListDurableExecutionsByFunctionRequest = {
        "function_name": function_name
    }
    if qualifier is not None:
        input_["qualifier"] = qualifier
    if durable_execution_name is not None:
        input_["durable_execution_name"] = durable_execution_name
    if statuses is not None:
        input_["statuses"] = statuses
    if started_after is not None:
        input_["started_after"] = started_after
    if started_before is not None:
        input_["started_before"] = started_before
    if reverse_order is not None:
        input_["reverse_order"] = reverse_order
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

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