Struct aws_sdk_quicksight::operation::get_session_embed_url::builders::GetSessionEmbedUrlInputBuilder

#[non_exhaustive]
pub struct GetSessionEmbedUrlInputBuilder { /* private fields */ }

A builder for GetSessionEmbedUrlInput.

Implementations

impl GetSessionEmbedUrlInputBuilder

pub fn aws_account_id(self, input: impl Into<String>) -> Self

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

This field is required.

pub fn set_aws_account_id(self, input: Option<String>) -> Self

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

pub fn get_aws_account_id(&self) -> &Option<String>

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

pub fn entry_point(self, input: impl Into<String>) -> Self

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

pub fn set_entry_point(self, input: Option<String>) -> Self

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

pub fn get_entry_point(&self) -> &Option<String>

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

• /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

pub fn session_lifetime_in_minutes(self, input: i64) -> Self

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

pub fn set_session_lifetime_in_minutes(self, input: Option<i64>) -> Self

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

pub fn get_session_lifetime_in_minutes(&self) -> &Option<i64>

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

pub fn user_arn(self, input: impl Into<String>) -> Self

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

1. Active Directory (AD) users or group members

2. Invited nonfederated users

3. IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

pub fn set_user_arn(self, input: Option<String>) -> Self

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

1. Active Directory (AD) users or group members

2. Invited nonfederated users

3. IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

pub fn get_user_arn(&self) -> &Option<String>

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

1. Active Directory (AD) users or group members

2. Invited nonfederated users

3. IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

pub fn build(self) -> Result<GetSessionEmbedUrlInput, BuildError>

Consumes the builder and constructs a GetSessionEmbedUrlInput.

impl GetSessionEmbedUrlInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<GetSessionEmbedUrlOutput, SdkError<GetSessionEmbedUrlError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetSessionEmbedUrlInputBuilder

fn clone(&self) -> GetSessionEmbedUrlInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetSessionEmbedUrlInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetSessionEmbedUrlInputBuilder

fn default() -> GetSessionEmbedUrlInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetSessionEmbedUrlInputBuilder

fn eq(&self, other: &GetSessionEmbedUrlInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetSessionEmbedUrlInputBuilder