aws_sdk_emr/client/list_notebook_executions.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListNotebookExecutions`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`editor_id(impl Into<String>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::editor_id) / [`set_editor_id(Option<String>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::set_editor_id):<br>required: **false**<br><p>The unique ID of the editor associated with the notebook execution.</p><br>
8 /// - [`status(NotebookExecutionStatus)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::status) / [`set_status(Option<NotebookExecutionStatus>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::set_status):<br>required: **false**<br><p>The status filter for listing notebook executions.</p> <ul> <li> <p><code>START_PENDING</code> indicates that the cluster has received the execution request but execution has not begun.</p></li> <li> <p><code>STARTING</code> indicates that the execution is starting on the cluster.</p></li> <li> <p><code>RUNNING</code> indicates that the execution is being processed by the cluster.</p></li> <li> <p><code>FINISHING</code> indicates that execution processing is in the final stages.</p></li> <li> <p><code>FINISHED</code> indicates that the execution has completed without error.</p></li> <li> <p><code>FAILING</code> indicates that the execution is failing and will not finish successfully.</p></li> <li> <p><code>FAILED</code> indicates that the execution failed.</p></li> <li> <p><code>STOP_PENDING</code> indicates that the cluster has received a <code>StopNotebookExecution</code> request and the stop is pending.</p></li> <li> <p><code>STOPPING</code> indicates that the cluster is in the process of stopping the execution as a result of a <code>StopNotebookExecution</code> request.</p></li> <li> <p><code>STOPPED</code> indicates that the execution stopped because of a <code>StopNotebookExecution</code> request.</p></li> </ul><br>
9 /// - [`from(DateTime)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::from) / [`set_from(Option<DateTime>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::set_from):<br>required: **false**<br><p>The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.</p><br>
10 /// - [`to(DateTime)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::to) / [`set_to(Option<DateTime>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::set_to):<br>required: **false**<br><p>The end of time range filter for listing notebook executions. The default is the current timestamp.</p><br>
11 /// - [`marker(impl Into<String>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::set_marker):<br>required: **false**<br><p>The pagination token, returned by a previous <code>ListNotebookExecutions</code> call, that indicates the start of the list for this <code>ListNotebookExecutions</code> call.</p><br>
12 /// - [`execution_engine_id(impl Into<String>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::execution_engine_id) / [`set_execution_engine_id(Option<String>)`](crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::set_execution_engine_id):<br>required: **false**<br><p>The unique ID of the execution engine.</p><br>
13 /// - On success, responds with [`ListNotebookExecutionsOutput`](crate::operation::list_notebook_executions::ListNotebookExecutionsOutput) with field(s):
14 /// - [`notebook_executions(Option<Vec::<NotebookExecutionSummary>>)`](crate::operation::list_notebook_executions::ListNotebookExecutionsOutput::notebook_executions): <p>A list of notebook executions.</p>
15 /// - [`marker(Option<String>)`](crate::operation::list_notebook_executions::ListNotebookExecutionsOutput::marker): <p>A pagination token that a subsequent <code>ListNotebookExecutions</code> can use to determine the next set of results to retrieve.</p>
16 /// - On failure, responds with [`SdkError<ListNotebookExecutionsError>`](crate::operation::list_notebook_executions::ListNotebookExecutionsError)
17 pub fn list_notebook_executions(&self) -> crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder {
18 crate::operation::list_notebook_executions::builders::ListNotebookExecutionsFluentBuilder::new(self.handle.clone())
19 }
20}