Lambda / Client / list_durable_executions_by_function

list_durable_executions_by_function

Lambda.Client.list_durable_executions_by_function(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_durable_executions_by_function(
    FunctionName='string',
    Qualifier='string',
    DurableExecutionName='string',
    Statuses=[
        'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'STOPPED',
    ],
    StartedAfter=datetime(2015, 1, 1),
    StartedBefore=datetime(2015, 1, 1),
    ReverseOrder=True|False,
    Marker='string',
    MaxItems=123
)
Parameters:

  • FunctionName (string) –

    [REQUIRED]

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

  • Qualifier (string) – The function version or alias. If not specified, lists executions for the $LATEST version.

  • DurableExecutionName (string) – Filter executions by name. Only executions with names that contain this string are returned.

  • Statuses (list) –

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

    • (string) –

  • StartedAfter (datetime) – Filter executions that started after this timestamp (ISO 8601 format).

  • StartedBefore (datetime) – Filter executions that started before this timestamp (ISO 8601 format).

  • ReverseOrder (boolean) – Set to true to return results in reverse chronological order (newest first). Default is false.

  • Marker (string) – Pagination token from a previous request to continue retrieving results.

  • MaxItems (integer) – Maximum number of executions to return (1-1000). Default is 100.

Return type:

dict

Returns:

Response Syntax

{
    'DurableExecutions': [
        {
            'DurableExecutionArn': 'string',
            'DurableExecutionName': 'string',
            'FunctionArn': 'string',
            'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'STOPPED',
            'StartTimestamp': datetime(2015, 1, 1),
            'EndTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) –

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

    • DurableExecutions (list) –

      List of durable execution summaries matching the filter criteria.

      • (dict) –

        Information about a durable execution.

        • DurableExecutionArn (string) –

          The Amazon Resource Name (ARN) of the durable execution, if this execution is a durable execution.

        • DurableExecutionName (string) –

          The unique name of the durable execution, if one was provided when the execution was started.

        • FunctionArn (string) –

          The Amazon Resource Name (ARN) of the Lambda function.

        • Status (string) –

          The current status of the durable execution.

        • StartTimestamp (datetime) –

          The date and time when the durable execution started, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

        • EndTimestamp (datetime) –

          The date and time when the durable execution ended, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

    • NextMarker (string) –

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

Exceptions

  • Lambda.Client.exceptions.InvalidParameterValueException

  • Lambda.Client.exceptions.TooManyRequestsException

  • Lambda.Client.exceptions.ServiceException

  • Lambda.Client.exceptions.ResourceNotFoundException