Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Provides summaries of all notebook executions. You can filter the list
based on multiple criteria such as status, time range, and editor id.
Returns a maximum of 50 notebook executions and a marker to track the
paging of a longer notebook execution list across multiple
ListNotebookExecution
calls.
This operation returns paginated results.
Synopsis
- data ListNotebookExecutions = ListNotebookExecutions' {}
- newListNotebookExecutions :: ListNotebookExecutions
- listNotebookExecutions_editorId :: Lens' ListNotebookExecutions (Maybe Text)
- listNotebookExecutions_from :: Lens' ListNotebookExecutions (Maybe UTCTime)
- listNotebookExecutions_marker :: Lens' ListNotebookExecutions (Maybe Text)
- listNotebookExecutions_status :: Lens' ListNotebookExecutions (Maybe NotebookExecutionStatus)
- listNotebookExecutions_to :: Lens' ListNotebookExecutions (Maybe UTCTime)
- data ListNotebookExecutionsResponse = ListNotebookExecutionsResponse' {}
- newListNotebookExecutionsResponse :: Int -> ListNotebookExecutionsResponse
- listNotebookExecutionsResponse_marker :: Lens' ListNotebookExecutionsResponse (Maybe Text)
- listNotebookExecutionsResponse_notebookExecutions :: Lens' ListNotebookExecutionsResponse (Maybe [NotebookExecutionSummary])
- listNotebookExecutionsResponse_httpStatus :: Lens' ListNotebookExecutionsResponse Int
Creating a Request
data ListNotebookExecutions Source #
See: newListNotebookExecutions
smart constructor.
ListNotebookExecutions' | |
|
Instances
newListNotebookExecutions :: ListNotebookExecutions Source #
Create a value of ListNotebookExecutions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListNotebookExecutions
, listNotebookExecutions_editorId
- The unique ID of the editor associated with the notebook execution.
$sel:from:ListNotebookExecutions'
, listNotebookExecutions_from
- The beginning of time range filter for listing notebook executions. The
default is the timestamp of 30 days ago.
ListNotebookExecutions
, listNotebookExecutions_marker
- The pagination token, returned by a previous ListNotebookExecutions
call, that indicates the start of the list for this
ListNotebookExecutions
call.
ListNotebookExecutions
, listNotebookExecutions_status
- The status filter for listing notebook executions.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.STARTING
indicates that the execution is starting on the cluster.RUNNING
indicates that the execution is being processed by the cluster.FINISHING
indicates that execution processing is in the final stages.FINISHED
indicates that the execution has completed without error.FAILING
indicates that the execution is failing and will not finish successfully.FAILED
indicates that the execution failed.STOP_PENDING
indicates that the cluster has received aStopNotebookExecution
request and the stop is pending.STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request.STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
$sel:to:ListNotebookExecutions'
, listNotebookExecutions_to
- The end of time range filter for listing notebook executions. The
default is the current timestamp.
Request Lenses
listNotebookExecutions_editorId :: Lens' ListNotebookExecutions (Maybe Text) Source #
The unique ID of the editor associated with the notebook execution.
listNotebookExecutions_from :: Lens' ListNotebookExecutions (Maybe UTCTime) Source #
The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
listNotebookExecutions_marker :: Lens' ListNotebookExecutions (Maybe Text) Source #
The pagination token, returned by a previous ListNotebookExecutions
call, that indicates the start of the list for this
ListNotebookExecutions
call.
listNotebookExecutions_status :: Lens' ListNotebookExecutions (Maybe NotebookExecutionStatus) Source #
The status filter for listing notebook executions.
START_PENDING
indicates that the cluster has received the execution request but execution has not begun.STARTING
indicates that the execution is starting on the cluster.RUNNING
indicates that the execution is being processed by the cluster.FINISHING
indicates that execution processing is in the final stages.FINISHED
indicates that the execution has completed without error.FAILING
indicates that the execution is failing and will not finish successfully.FAILED
indicates that the execution failed.STOP_PENDING
indicates that the cluster has received aStopNotebookExecution
request and the stop is pending.STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request.STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
listNotebookExecutions_to :: Lens' ListNotebookExecutions (Maybe UTCTime) Source #
The end of time range filter for listing notebook executions. The default is the current timestamp.
Destructuring the Response
data ListNotebookExecutionsResponse Source #
See: newListNotebookExecutionsResponse
smart constructor.
ListNotebookExecutionsResponse' | |
|
Instances
newListNotebookExecutionsResponse Source #
Create a value of ListNotebookExecutionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListNotebookExecutions
, listNotebookExecutionsResponse_marker
- A pagination token that a subsequent ListNotebookExecutions
can use to
determine the next set of results to retrieve.
$sel:notebookExecutions:ListNotebookExecutionsResponse'
, listNotebookExecutionsResponse_notebookExecutions
- A list of notebook executions.
$sel:httpStatus:ListNotebookExecutionsResponse'
, listNotebookExecutionsResponse_httpStatus
- The response's http status code.
Response Lenses
listNotebookExecutionsResponse_marker :: Lens' ListNotebookExecutionsResponse (Maybe Text) Source #
A pagination token that a subsequent ListNotebookExecutions
can use to
determine the next set of results to retrieve.
listNotebookExecutionsResponse_notebookExecutions :: Lens' ListNotebookExecutionsResponse (Maybe [NotebookExecutionSummary]) Source #
A list of notebook executions.
listNotebookExecutionsResponse_httpStatus :: Lens' ListNotebookExecutionsResponse Int Source #
The response's http status code.