#[non_exhaustive]pub enum GetDashboardEmbedUrlError {
Show 13 variants
AccessDeniedException(AccessDeniedException),
DomainNotWhitelistedException(DomainNotWhitelistedException),
IdentityTypeNotSupportedException(IdentityTypeNotSupportedException),
InternalFailureException(InternalFailureException),
InvalidParameterValueException(InvalidParameterValueException),
QuickSightUserNotFoundException(QuickSightUserNotFoundException),
ResourceExistsException(ResourceExistsException),
ResourceNotFoundException(ResourceNotFoundException),
SessionLifetimeInMinutesInvalidException(SessionLifetimeInMinutesInvalidException),
ThrottlingException(ThrottlingException),
UnsupportedPricingPlanException(UnsupportedPricingPlanException),
UnsupportedUserEditionException(UnsupportedUserEditionException),
Unhandled(Unhandled),
}
Expand description
Error type for the GetDashboardEmbedUrlError
operation.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
AccessDeniedException(AccessDeniedException)
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
DomainNotWhitelistedException(DomainNotWhitelistedException)
The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
IdentityTypeNotSupportedException(IdentityTypeNotSupportedException)
The identity type specified isn't supported. Supported identity types include IAM
and QUICKSIGHT
.
InternalFailureException(InternalFailureException)
An internal failure occurred.
InvalidParameterValueException(InvalidParameterValueException)
One or more parameters has a value that isn't valid.
QuickSightUserNotFoundException(QuickSightUserNotFoundException)
The user with the provided name isn't found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so on.
ResourceExistsException(ResourceExistsException)
The resource specified already exists.
ResourceNotFoundException(ResourceNotFoundException)
One or more resources can't be found.
SessionLifetimeInMinutesInvalidException(SessionLifetimeInMinutesInvalidException)
The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
ThrottlingException(ThrottlingException)
Access is throttled.
UnsupportedPricingPlanException(UnsupportedPricingPlanException)
This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
UnsupportedUserEditionException(UnsupportedUserEditionException)
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
Unhandled(Unhandled)
Unhandled
directly is not forwards compatible. Instead, match using a variable wildcard pattern and check .code()
:
err if err.code() == Some("SpecificExceptionCode") => { /* handle the error */ }
See ProvideErrorMetadata
for what information is available for the error.An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
Implementations§
Source§impl GetDashboardEmbedUrlError
impl GetDashboardEmbedUrlError
Sourcepub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
pub fn unhandled(err: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self
Creates the GetDashboardEmbedUrlError::Unhandled
variant from any error type.
Sourcepub fn generic(err: ErrorMetadata) -> Self
pub fn generic(err: ErrorMetadata) -> Self
Creates the GetDashboardEmbedUrlError::Unhandled
variant from an ErrorMetadata
.
Sourcepub fn meta(&self) -> &ErrorMetadata
pub fn meta(&self) -> &ErrorMetadata
Returns error metadata, which includes the error code, message, request ID, and potentially additional information.
Sourcepub fn is_access_denied_exception(&self) -> bool
pub fn is_access_denied_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::AccessDeniedException
.
Sourcepub fn is_domain_not_whitelisted_exception(&self) -> bool
pub fn is_domain_not_whitelisted_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::DomainNotWhitelistedException
.
Sourcepub fn is_identity_type_not_supported_exception(&self) -> bool
pub fn is_identity_type_not_supported_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::IdentityTypeNotSupportedException
.
Sourcepub fn is_internal_failure_exception(&self) -> bool
pub fn is_internal_failure_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::InternalFailureException
.
Sourcepub fn is_invalid_parameter_value_exception(&self) -> bool
pub fn is_invalid_parameter_value_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::InvalidParameterValueException
.
Sourcepub fn is_quick_sight_user_not_found_exception(&self) -> bool
pub fn is_quick_sight_user_not_found_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::QuickSightUserNotFoundException
.
Sourcepub fn is_resource_exists_exception(&self) -> bool
pub fn is_resource_exists_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::ResourceExistsException
.
Sourcepub fn is_resource_not_found_exception(&self) -> bool
pub fn is_resource_not_found_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::ResourceNotFoundException
.
Sourcepub fn is_session_lifetime_in_minutes_invalid_exception(&self) -> bool
pub fn is_session_lifetime_in_minutes_invalid_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::SessionLifetimeInMinutesInvalidException
.
Sourcepub fn is_throttling_exception(&self) -> bool
pub fn is_throttling_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::ThrottlingException
.
Sourcepub fn is_unsupported_pricing_plan_exception(&self) -> bool
pub fn is_unsupported_pricing_plan_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::UnsupportedPricingPlanException
.
Sourcepub fn is_unsupported_user_edition_exception(&self) -> bool
pub fn is_unsupported_user_edition_exception(&self) -> bool
Returns true
if the error kind is GetDashboardEmbedUrlError::UnsupportedUserEditionException
.
Trait Implementations§
Source§impl CreateUnhandledError for GetDashboardEmbedUrlError
impl CreateUnhandledError for GetDashboardEmbedUrlError
Source§fn create_unhandled_error(
source: Box<dyn Error + Send + Sync + 'static>,
meta: Option<ErrorMetadata>,
) -> Self
fn create_unhandled_error( source: Box<dyn Error + Send + Sync + 'static>, meta: Option<ErrorMetadata>, ) -> Self
source
and error metadata.Source§impl Debug for GetDashboardEmbedUrlError
impl Debug for GetDashboardEmbedUrlError
Source§impl Display for GetDashboardEmbedUrlError
impl Display for GetDashboardEmbedUrlError
Source§impl Error for GetDashboardEmbedUrlError
impl Error for GetDashboardEmbedUrlError
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
Source§impl From<GetDashboardEmbedUrlError> for Error
impl From<GetDashboardEmbedUrlError> for Error
Source§fn from(err: GetDashboardEmbedUrlError) -> Self
fn from(err: GetDashboardEmbedUrlError) -> Self
Source§impl ProvideErrorMetadata for GetDashboardEmbedUrlError
impl ProvideErrorMetadata for GetDashboardEmbedUrlError
Source§fn meta(&self) -> &ErrorMetadata
fn meta(&self) -> &ErrorMetadata
Source§impl RequestId for GetDashboardEmbedUrlError
impl RequestId for GetDashboardEmbedUrlError
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.Auto Trait Implementations§
impl Freeze for GetDashboardEmbedUrlError
impl !RefUnwindSafe for GetDashboardEmbedUrlError
impl Send for GetDashboardEmbedUrlError
impl Sync for GetDashboardEmbedUrlError
impl Unpin for GetDashboardEmbedUrlError
impl !UnwindSafe for GetDashboardEmbedUrlError
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> 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);