pub struct StartNotebookExecutionFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartNotebookExecution
.
Starts a notebook execution.
Implementations§
Source§impl StartNotebookExecutionFluentBuilder
impl StartNotebookExecutionFluentBuilder
Sourcepub fn as_input(&self) -> &StartNotebookExecutionInputBuilder
pub fn as_input(&self) -> &StartNotebookExecutionInputBuilder
Access the StartNotebookExecution as a reference.
Sourcepub async fn send(
self,
) -> Result<StartNotebookExecutionOutput, SdkError<StartNotebookExecutionError, HttpResponse>>
pub async fn send( self, ) -> Result<StartNotebookExecutionOutput, SdkError<StartNotebookExecutionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartNotebookExecutionOutput, StartNotebookExecutionError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartNotebookExecutionOutput, StartNotebookExecutionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn editor_id(self, input: impl Into<String>) -> Self
pub fn editor_id(self, input: impl Into<String>) -> Self
The unique identifier of the Amazon EMR Notebook to use for notebook execution.
Sourcepub fn set_editor_id(self, input: Option<String>) -> Self
pub fn set_editor_id(self, input: Option<String>) -> Self
The unique identifier of the Amazon EMR Notebook to use for notebook execution.
Sourcepub fn get_editor_id(&self) -> &Option<String>
pub fn get_editor_id(&self) -> &Option<String>
The unique identifier of the Amazon EMR Notebook to use for notebook execution.
Sourcepub fn relative_path(self, input: impl Into<String>) -> Self
pub fn relative_path(self, input: impl Into<String>) -> Self
The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks
when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this request), and you specify a RelativePath
of my_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
Sourcepub fn set_relative_path(self, input: Option<String>) -> Self
pub fn set_relative_path(self, input: Option<String>) -> Self
The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks
when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this request), and you specify a RelativePath
of my_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
Sourcepub fn get_relative_path(&self) -> &Option<String>
pub fn get_relative_path(&self) -> &Option<String>
The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks
when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD
(the EditorID
of this request), and you specify a RelativePath
of my_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
Sourcepub fn notebook_execution_name(self, input: impl Into<String>) -> Self
pub fn notebook_execution_name(self, input: impl Into<String>) -> Self
An optional name for the notebook execution.
Sourcepub fn set_notebook_execution_name(self, input: Option<String>) -> Self
pub fn set_notebook_execution_name(self, input: Option<String>) -> Self
An optional name for the notebook execution.
Sourcepub fn get_notebook_execution_name(&self) -> &Option<String>
pub fn get_notebook_execution_name(&self) -> &Option<String>
An optional name for the notebook execution.
Sourcepub fn notebook_params(self, input: impl Into<String>) -> Self
pub fn notebook_params(self, input: impl Into<String>) -> Self
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Sourcepub fn set_notebook_params(self, input: Option<String>) -> Self
pub fn set_notebook_params(self, input: Option<String>) -> Self
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Sourcepub fn get_notebook_params(&self) -> &Option<String>
pub fn get_notebook_params(&self) -> &Option<String>
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
Sourcepub fn execution_engine(self, input: ExecutionEngineConfig) -> Self
pub fn execution_engine(self, input: ExecutionEngineConfig) -> Self
Specifies the execution engine (cluster) that runs the notebook execution.
Sourcepub fn set_execution_engine(self, input: Option<ExecutionEngineConfig>) -> Self
pub fn set_execution_engine(self, input: Option<ExecutionEngineConfig>) -> Self
Specifies the execution engine (cluster) that runs the notebook execution.
Sourcepub fn get_execution_engine(&self) -> &Option<ExecutionEngineConfig>
pub fn get_execution_engine(&self) -> &Option<ExecutionEngineConfig>
Specifies the execution engine (cluster) that runs the notebook execution.
Sourcepub fn service_role(self, input: impl Into<String>) -> Self
pub fn service_role(self, input: impl Into<String>) -> Self
The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
Sourcepub fn set_service_role(self, input: Option<String>) -> Self
pub fn set_service_role(self, input: Option<String>) -> Self
The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
Sourcepub fn get_service_role(&self) -> &Option<String>
pub fn get_service_role(&self) -> &Option<String>
The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
Sourcepub fn notebook_instance_security_group_id(
self,
input: impl Into<String>,
) -> Self
pub fn notebook_instance_security_group_id( self, input: impl Into<String>, ) -> Self
The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
Sourcepub fn set_notebook_instance_security_group_id(
self,
input: Option<String>,
) -> Self
pub fn set_notebook_instance_security_group_id( self, input: Option<String>, ) -> Self
The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
Sourcepub fn get_notebook_instance_security_group_id(&self) -> &Option<String>
pub fn get_notebook_instance_security_group_id(&self) -> &Option<String>
The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
Sourcepub fn notebook_s3_location(self, input: NotebookS3LocationFromInput) -> Self
pub fn notebook_s3_location(self, input: NotebookS3LocationFromInput) -> Self
The Amazon S3 location for the notebook execution input.
Sourcepub fn set_notebook_s3_location(
self,
input: Option<NotebookS3LocationFromInput>,
) -> Self
pub fn set_notebook_s3_location( self, input: Option<NotebookS3LocationFromInput>, ) -> Self
The Amazon S3 location for the notebook execution input.
Sourcepub fn get_notebook_s3_location(&self) -> &Option<NotebookS3LocationFromInput>
pub fn get_notebook_s3_location(&self) -> &Option<NotebookS3LocationFromInput>
The Amazon S3 location for the notebook execution input.
Sourcepub fn output_notebook_s3_location(
self,
input: OutputNotebookS3LocationFromInput,
) -> Self
pub fn output_notebook_s3_location( self, input: OutputNotebookS3LocationFromInput, ) -> Self
The Amazon S3 location for the notebook execution output.
Sourcepub fn set_output_notebook_s3_location(
self,
input: Option<OutputNotebookS3LocationFromInput>,
) -> Self
pub fn set_output_notebook_s3_location( self, input: Option<OutputNotebookS3LocationFromInput>, ) -> Self
The Amazon S3 location for the notebook execution output.
Sourcepub fn get_output_notebook_s3_location(
&self,
) -> &Option<OutputNotebookS3LocationFromInput>
pub fn get_output_notebook_s3_location( &self, ) -> &Option<OutputNotebookS3LocationFromInput>
The Amazon S3 location for the notebook execution output.
Sourcepub fn output_notebook_format(self, input: OutputNotebookFormat) -> Self
pub fn output_notebook_format(self, input: OutputNotebookFormat) -> Self
The output format for the notebook execution.
Sourcepub fn set_output_notebook_format(
self,
input: Option<OutputNotebookFormat>,
) -> Self
pub fn set_output_notebook_format( self, input: Option<OutputNotebookFormat>, ) -> Self
The output format for the notebook execution.
Sourcepub fn get_output_notebook_format(&self) -> &Option<OutputNotebookFormat>
pub fn get_output_notebook_format(&self) -> &Option<OutputNotebookFormat>
The output format for the notebook execution.
Sourcepub fn environment_variables(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn environment_variables( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to EnvironmentVariables
.
To override the contents of this collection use set_environment_variables
.
The environment variables associated with the notebook execution.
Trait Implementations§
Source§impl Clone for StartNotebookExecutionFluentBuilder
impl Clone for StartNotebookExecutionFluentBuilder
Source§fn clone(&self) -> StartNotebookExecutionFluentBuilder
fn clone(&self) -> StartNotebookExecutionFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for StartNotebookExecutionFluentBuilder
impl !RefUnwindSafe for StartNotebookExecutionFluentBuilder
impl Send for StartNotebookExecutionFluentBuilder
impl Sync for StartNotebookExecutionFluentBuilder
impl Unpin for StartNotebookExecutionFluentBuilder
impl !UnwindSafe for StartNotebookExecutionFluentBuilder
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);