#[non_exhaustive]pub struct NotebookExecution {Show 17 fields
pub notebook_execution_id: Option<String>,
pub editor_id: Option<String>,
pub execution_engine: Option<ExecutionEngineConfig>,
pub notebook_execution_name: Option<String>,
pub notebook_params: Option<String>,
pub status: Option<NotebookExecutionStatus>,
pub start_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub arn: Option<String>,
pub output_notebook_uri: Option<String>,
pub last_state_change_reason: Option<String>,
pub notebook_instance_security_group_id: Option<String>,
pub tags: Option<Vec<Tag>>,
pub notebook_s3_location: Option<NotebookS3LocationForOutput>,
pub output_notebook_s3_location: Option<OutputNotebookS3LocationForOutput>,
pub output_notebook_format: Option<OutputNotebookFormat>,
pub environment_variables: Option<HashMap<String, String>>,
}
Expand description
A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution
action.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.notebook_execution_id: Option<String>
The unique identifier of a notebook execution.
editor_id: Option<String>
The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
execution_engine: Option<ExecutionEngineConfig>
The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
notebook_execution_name: Option<String>
A name for the notebook execution.
notebook_params: Option<String>
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
status: Option<NotebookExecutionStatus>
The status of the notebook execution.
-
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.
start_time: Option<DateTime>
The timestamp when notebook execution started.
end_time: Option<DateTime>
The timestamp when notebook execution ended.
arn: Option<String>
The Amazon Resource Name (ARN) of the notebook execution.
output_notebook_uri: Option<String>
The location of the notebook execution's output file in Amazon S3.
last_state_change_reason: Option<String>
The reason for the latest status change of the notebook execution.
notebook_instance_security_group_id: Option<String>
The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
notebook_s3_location: Option<NotebookS3LocationForOutput>
The Amazon S3 location that stores the notebook execution input.
output_notebook_s3_location: Option<OutputNotebookS3LocationForOutput>
The Amazon S3 location for the notebook execution output.
output_notebook_format: Option<OutputNotebookFormat>
The output format for the notebook execution.
environment_variables: Option<HashMap<String, String>>
The environment variables associated with the notebook execution.
Implementations§
Source§impl NotebookExecution
impl NotebookExecution
Sourcepub fn notebook_execution_id(&self) -> Option<&str>
pub fn notebook_execution_id(&self) -> Option<&str>
The unique identifier of a notebook execution.
Sourcepub fn editor_id(&self) -> Option<&str>
pub fn editor_id(&self) -> Option<&str>
The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
Sourcepub fn execution_engine(&self) -> Option<&ExecutionEngineConfig>
pub fn execution_engine(&self) -> Option<&ExecutionEngineConfig>
The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.
Sourcepub fn notebook_execution_name(&self) -> Option<&str>
pub fn notebook_execution_name(&self) -> Option<&str>
A name for the notebook execution.
Sourcepub fn notebook_params(&self) -> Option<&str>
pub fn notebook_params(&self) -> Option<&str>
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Sourcepub fn status(&self) -> Option<&NotebookExecutionStatus>
pub fn status(&self) -> Option<&NotebookExecutionStatus>
The status of the notebook execution.
-
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.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The timestamp when notebook execution started.
Sourcepub fn output_notebook_uri(&self) -> Option<&str>
pub fn output_notebook_uri(&self) -> Option<&str>
The location of the notebook execution's output file in Amazon S3.
Sourcepub fn last_state_change_reason(&self) -> Option<&str>
pub fn last_state_change_reason(&self) -> Option<&str>
The reason for the latest status change of the notebook execution.
Sourcepub fn notebook_instance_security_group_id(&self) -> Option<&str>
pub fn notebook_instance_security_group_id(&self) -> Option<&str>
The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.
A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
Sourcepub fn notebook_s3_location(&self) -> Option<&NotebookS3LocationForOutput>
pub fn notebook_s3_location(&self) -> Option<&NotebookS3LocationForOutput>
The Amazon S3 location that stores the notebook execution input.
Sourcepub fn output_notebook_s3_location(
&self,
) -> Option<&OutputNotebookS3LocationForOutput>
pub fn output_notebook_s3_location( &self, ) -> Option<&OutputNotebookS3LocationForOutput>
The Amazon S3 location for the notebook execution output.
Sourcepub fn output_notebook_format(&self) -> Option<&OutputNotebookFormat>
pub fn output_notebook_format(&self) -> Option<&OutputNotebookFormat>
The output format for the notebook execution.
Source§impl NotebookExecution
impl NotebookExecution
Sourcepub fn builder() -> NotebookExecutionBuilder
pub fn builder() -> NotebookExecutionBuilder
Creates a new builder-style object to manufacture NotebookExecution
.
Trait Implementations§
Source§impl Clone for NotebookExecution
impl Clone for NotebookExecution
Source§fn clone(&self) -> NotebookExecution
fn clone(&self) -> NotebookExecution
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for NotebookExecution
impl Debug for NotebookExecution
Source§impl PartialEq for NotebookExecution
impl PartialEq for NotebookExecution
impl StructuralPartialEq for NotebookExecution
Auto Trait Implementations§
impl Freeze for NotebookExecution
impl RefUnwindSafe for NotebookExecution
impl Send for NotebookExecution
impl Sync for NotebookExecution
impl Unpin for NotebookExecution
impl UnwindSafe for NotebookExecution
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);