1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_session_embed_url::_get_session_embed_url_output::GetSessionEmbedUrlOutputBuilder;
pub use crate::operation::get_session_embed_url::_get_session_embed_url_input::GetSessionEmbedUrlInputBuilder;
/// Fluent builder constructing a request to `GetSessionEmbedUrl`.
///
/// <p>Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> </code> API operation. Use <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a> </code> API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the <i>Amazon QuickSight User Guide</i>:</p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedding Analytics</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a> </p> </li>
/// </ul>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetSessionEmbedUrlFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_session_embed_url::builders::GetSessionEmbedUrlInputBuilder,
}
impl GetSessionEmbedUrlFluentBuilder {
/// Creates a new `GetSessionEmbedUrl`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::get_session_embed_url::GetSessionEmbedUrl,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::get_session_embed_url::GetSessionEmbedUrlError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::get_session_embed_url::GetSessionEmbedUrlOutput,
aws_smithy_http::result::SdkError<
crate::operation::get_session_embed_url::GetSessionEmbedUrlError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>
pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.aws_account_id(input.into());
self
}
/// <p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>
pub fn set_aws_account_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_aws_account_id(input);
self
}
/// <p>The URL you use to access the embedded session. The entry point URL is constrained to the following paths:</p>
/// <ul>
/// <li> <p> <code>/start</code> </p> </li>
/// <li> <p> <code>/start/analyses</code> </p> </li>
/// <li> <p> <code>/start/dashboards</code> </p> </li>
/// <li> <p> <code>/start/favorites</code> </p> </li>
/// <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard</p> </li>
/// <li> <p> <code>/analyses/<i>AnalysisId</i> </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis</p> </li>
/// </ul>
pub fn entry_point(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.entry_point(input.into());
self
}
/// <p>The URL you use to access the embedded session. The entry point URL is constrained to the following paths:</p>
/// <ul>
/// <li> <p> <code>/start</code> </p> </li>
/// <li> <p> <code>/start/analyses</code> </p> </li>
/// <li> <p> <code>/start/dashboards</code> </p> </li>
/// <li> <p> <code>/start/favorites</code> </p> </li>
/// <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard</p> </li>
/// <li> <p> <code>/analyses/<i>AnalysisId</i> </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis</p> </li>
/// </ul>
pub fn set_entry_point(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_entry_point(input);
self
}
/// <p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>
pub fn session_lifetime_in_minutes(mut self, input: i64) -> Self {
self.inner = self.inner.session_lifetime_in_minutes(input);
self
}
/// <p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>
pub fn set_session_lifetime_in_minutes(mut self, input: std::option::Option<i64>) -> Self {
self.inner = self.inner.set_session_lifetime_in_minutes(input);
self
}
/// <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> 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:</p>
/// <ol>
/// <li> <p>Active Directory (AD) users or group members</p> </li>
/// <li> <p>Invited nonfederated users</p> </li>
/// <li> <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li>
/// </ol>
/// <p>Omit this parameter for users in the third group, IAM users and IAM role-based sessions.</p>
pub fn user_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.user_arn(input.into());
self
}
/// <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> 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:</p>
/// <ol>
/// <li> <p>Active Directory (AD) users or group members</p> </li>
/// <li> <p>Invited nonfederated users</p> </li>
/// <li> <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li>
/// </ol>
/// <p>Omit this parameter for users in the third group, IAM users and IAM role-based sessions.</p>
pub fn set_user_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_user_arn(input);
self
}
}