pub struct CreatePresignedDomainUrlFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreatePresignedDomainUrl.
Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM.
The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.
You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker AI Studio Through an Interface VPC Endpoint .
-
The URL that you get from a call to
CreatePresignedDomainUrlhas a default timeout of 5 minutes. You can configure this value usingExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page. -
The JupyterLab session default expiration time is 12 hours. You can configure this value using SessionExpirationDurationInSeconds.
Implementations§
Source§impl CreatePresignedDomainUrlFluentBuilder
impl CreatePresignedDomainUrlFluentBuilder
Sourcepub fn as_input(&self) -> &CreatePresignedDomainUrlInputBuilder
pub fn as_input(&self) -> &CreatePresignedDomainUrlInputBuilder
Access the CreatePresignedDomainUrl as a reference.
Sourcepub async fn send(
self,
) -> Result<CreatePresignedDomainUrlOutput, SdkError<CreatePresignedDomainUrlError, HttpResponse>>
pub async fn send( self, ) -> Result<CreatePresignedDomainUrlOutput, SdkError<CreatePresignedDomainUrlError, 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<CreatePresignedDomainUrlOutput, CreatePresignedDomainUrlError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreatePresignedDomainUrlOutput, CreatePresignedDomainUrlError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn set_domain_id(self, input: Option<String>) -> Self
pub fn set_domain_id(self, input: Option<String>) -> Self
The domain ID.
Sourcepub fn get_domain_id(&self) -> &Option<String>
pub fn get_domain_id(&self) -> &Option<String>
The domain ID.
Sourcepub fn user_profile_name(self, input: impl Into<String>) -> Self
pub fn user_profile_name(self, input: impl Into<String>) -> Self
The name of the UserProfile to sign-in as.
Sourcepub fn set_user_profile_name(self, input: Option<String>) -> Self
pub fn set_user_profile_name(self, input: Option<String>) -> Self
The name of the UserProfile to sign-in as.
Sourcepub fn get_user_profile_name(&self) -> &Option<String>
pub fn get_user_profile_name(&self) -> &Option<String>
The name of the UserProfile to sign-in as.
Sourcepub fn session_expiration_duration_in_seconds(self, input: i32) -> Self
pub fn session_expiration_duration_in_seconds(self, input: i32) -> Self
The session expiration duration in seconds. This value defaults to 43200.
Sourcepub fn set_session_expiration_duration_in_seconds(
self,
input: Option<i32>,
) -> Self
pub fn set_session_expiration_duration_in_seconds( self, input: Option<i32>, ) -> Self
The session expiration duration in seconds. This value defaults to 43200.
Sourcepub fn get_session_expiration_duration_in_seconds(&self) -> &Option<i32>
pub fn get_session_expiration_duration_in_seconds(&self) -> &Option<i32>
The session expiration duration in seconds. This value defaults to 43200.
Sourcepub fn expires_in_seconds(self, input: i32) -> Self
pub fn expires_in_seconds(self, input: i32) -> Self
The number of seconds until the pre-signed URL expires. This value defaults to 300.
Sourcepub fn set_expires_in_seconds(self, input: Option<i32>) -> Self
pub fn set_expires_in_seconds(self, input: Option<i32>) -> Self
The number of seconds until the pre-signed URL expires. This value defaults to 300.
Sourcepub fn get_expires_in_seconds(&self) -> &Option<i32>
pub fn get_expires_in_seconds(&self) -> &Option<i32>
The number of seconds until the pre-signed URL expires. This value defaults to 300.
Sourcepub fn space_name(self, input: impl Into<String>) -> Self
pub fn space_name(self, input: impl Into<String>) -> Self
The name of the space.
Sourcepub fn set_space_name(self, input: Option<String>) -> Self
pub fn set_space_name(self, input: Option<String>) -> Self
The name of the space.
Sourcepub fn get_space_name(&self) -> &Option<String>
pub fn get_space_name(&self) -> &Option<String>
The name of the space.
Sourcepub fn landing_uri(self, input: impl Into<String>) -> Self
pub fn landing_uri(self, input: impl Into<String>) -> Self
The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:
-
studio::relative/path: Directs users to the relative path in Studio. -
app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application. -
app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application. -
app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application. -
app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. -
app:Canvas:relative/path: Directs users to the relative path in the Canvas application.
Sourcepub fn set_landing_uri(self, input: Option<String>) -> Self
pub fn set_landing_uri(self, input: Option<String>) -> Self
The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:
-
studio::relative/path: Directs users to the relative path in Studio. -
app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application. -
app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application. -
app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application. -
app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. -
app:Canvas:relative/path: Directs users to the relative path in the Canvas application.
Sourcepub fn get_landing_uri(&self) -> &Option<String>
pub fn get_landing_uri(&self) -> &Option<String>
The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:
-
studio::relative/path: Directs users to the relative path in Studio. -
app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application. -
app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application. -
app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application. -
app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application. -
app:Canvas:relative/path: Directs users to the relative path in the Canvas application.
Trait Implementations§
Source§impl Clone for CreatePresignedDomainUrlFluentBuilder
impl Clone for CreatePresignedDomainUrlFluentBuilder
Source§fn clone(&self) -> CreatePresignedDomainUrlFluentBuilder
fn clone(&self) -> CreatePresignedDomainUrlFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreatePresignedDomainUrlFluentBuilder
impl !RefUnwindSafe for CreatePresignedDomainUrlFluentBuilder
impl Send for CreatePresignedDomainUrlFluentBuilder
impl Sync for CreatePresignedDomainUrlFluentBuilder
impl Unpin for CreatePresignedDomainUrlFluentBuilder
impl !UnwindSafe for CreatePresignedDomainUrlFluentBuilder
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);