Skip to content

list_durable_executions_by_function

Operation

list_durable_executions_by_function

list_durable_executions_by_function(request: ListDurableExecutionsByFunctionInput | ListDurableExecutionsByFunctionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDurableExecutionsByFunctionInputDict]) -> ListDurableExecutionsByFunctionOutput

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:

Name Type Description Default
request ListDurableExecutionsByFunctionInput | ListDurableExecutionsByFunctionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListDurableExecutionsByFunctionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDurableExecutionsByFunctionOutput

An instance of ListDurableExecutionsByFunctionOutput.

list_durable_executions_by_function async

list_durable_executions_by_function(request: ListDurableExecutionsByFunctionInput | ListDurableExecutionsByFunctionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDurableExecutionsByFunctionInputDict]) -> ListDurableExecutionsByFunctionOutput

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:

Name Type Description Default
request ListDurableExecutionsByFunctionInput | ListDurableExecutionsByFunctionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListDurableExecutionsByFunctionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDurableExecutionsByFunctionOutput

An instance of ListDurableExecutionsByFunctionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListDurableExecutionsByFunctionInputDict

Bases: TypedDict

Dictionary form of ListDurableExecutionsByFunctionInput.

Attributes

durable_execution_name instance-attribute
durable_execution_name: str | None

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

function_name instance-attribute
function_name: Required[str]

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

marker instance-attribute
marker: str | None

Pagination token from a previous request to continue retrieving results.

max_items instance-attribute
max_items: int | None

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

qualifier instance-attribute
qualifier: str | 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.

reverse_order instance-attribute
reverse_order: bool | None

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

started_after instance-attribute
started_after: datetime | None

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

started_before instance-attribute
started_before: datetime | None

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

statuses instance-attribute
statuses: Sequence[str] | None

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

ListDurableExecutionsByFunctionInput dataclass

Bases: _SerdeShape

Dataclass for ListDurableExecutionsByFunctionInput structure.

Attributes

durable_execution_name class-attribute instance-attribute
durable_execution_name: str | None = ...

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

function_name class-attribute instance-attribute
function_name: str | None = ...

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

marker class-attribute instance-attribute
marker: str | None = ...

Pagination token from a previous request to continue retrieving results.

max_items class-attribute instance-attribute
max_items: int = ...

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

qualifier class-attribute instance-attribute
qualifier: str | 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.

reverse_order class-attribute instance-attribute
reverse_order: bool | None = ...

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

started_after class-attribute instance-attribute
started_after: datetime | None = ...

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

started_before class-attribute instance-attribute
started_before: datetime | None = ...

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

statuses class-attribute instance-attribute
statuses: list[str] | None = ...

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

Output

ListDurableExecutionsByFunctionOutput dataclass

Bases: _SerdeShape

The response from the ListDurableExecutionsByFunction operation, containing a list of durable executions and pagination information.

Attributes

durable_executions class-attribute instance-attribute
durable_executions: list[Execution] | None = ...

List of durable execution summaries matching the filter criteria.

next_marker class-attribute instance-attribute
next_marker: str | None = ...

Pagination token for retrieving additional results. Present only if there are more results available.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.