AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration Class Reference

#include <RegisteredUserEmbeddingExperienceConfiguration.h>

Public Member Functions

 RegisteredUserEmbeddingExperienceConfiguration ()
 
 RegisteredUserEmbeddingExperienceConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
RegisteredUserEmbeddingExperienceConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const RegisteredUserDashboardEmbeddingConfigurationGetDashboard () const
 
bool DashboardHasBeenSet () const
 
void SetDashboard (const RegisteredUserDashboardEmbeddingConfiguration &value)
 
void SetDashboard (RegisteredUserDashboardEmbeddingConfiguration &&value)
 
RegisteredUserEmbeddingExperienceConfigurationWithDashboard (const RegisteredUserDashboardEmbeddingConfiguration &value)
 
RegisteredUserEmbeddingExperienceConfigurationWithDashboard (RegisteredUserDashboardEmbeddingConfiguration &&value)
 
const RegisteredUserQuickSightConsoleEmbeddingConfigurationGetQuickSightConsole () const
 
bool QuickSightConsoleHasBeenSet () const
 
void SetQuickSightConsole (const RegisteredUserQuickSightConsoleEmbeddingConfiguration &value)
 
void SetQuickSightConsole (RegisteredUserQuickSightConsoleEmbeddingConfiguration &&value)
 
RegisteredUserEmbeddingExperienceConfigurationWithQuickSightConsole (const RegisteredUserQuickSightConsoleEmbeddingConfiguration &value)
 
RegisteredUserEmbeddingExperienceConfigurationWithQuickSightConsole (RegisteredUserQuickSightConsoleEmbeddingConfiguration &&value)
 
const RegisteredUserQSearchBarEmbeddingConfigurationGetQSearchBar () const
 
bool QSearchBarHasBeenSet () const
 
void SetQSearchBar (const RegisteredUserQSearchBarEmbeddingConfiguration &value)
 
void SetQSearchBar (RegisteredUserQSearchBarEmbeddingConfiguration &&value)
 
RegisteredUserEmbeddingExperienceConfigurationWithQSearchBar (const RegisteredUserQSearchBarEmbeddingConfiguration &value)
 
RegisteredUserEmbeddingExperienceConfigurationWithQSearchBar (RegisteredUserQSearchBarEmbeddingConfiguration &&value)
 

Detailed Description

The type of experience you want to embed. For registered users, you can embed an Amazon QuickSight dashboard or the Amazon QuickSight console.

Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuraton.

See Also:

AWS API Reference

Definition at line 37 of file RegisteredUserEmbeddingExperienceConfiguration.h.

Constructor & Destructor Documentation

◆ RegisteredUserEmbeddingExperienceConfiguration() [1/2]

Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::RegisteredUserEmbeddingExperienceConfiguration ( )

◆ RegisteredUserEmbeddingExperienceConfiguration() [2/2]

Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::RegisteredUserEmbeddingExperienceConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DashboardHasBeenSet()

bool Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::DashboardHasBeenSet ( ) const
inline

The configuration details for providing a dashboard embedding experience.

Definition at line 54 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ GetDashboard()

const RegisteredUserDashboardEmbeddingConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::GetDashboard ( ) const
inline

The configuration details for providing a dashboard embedding experience.

Definition at line 49 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ GetQSearchBar()

const RegisteredUserQSearchBarEmbeddingConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::GetQSearchBar ( ) const
inline

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview.

Definition at line 252 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ GetQuickSightConsole()

const RegisteredUserQuickSightConsoleEmbeddingConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::GetQuickSightConsole ( ) const
inline

The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Definition at line 103 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::Jsonize ( ) const

◆ operator=()

RegisteredUserEmbeddingExperienceConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ QSearchBarHasBeenSet()

bool Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::QSearchBarHasBeenSet ( ) const
inline

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview.

Definition at line 260 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ QuickSightConsoleHasBeenSet()

bool Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::QuickSightConsoleHasBeenSet ( ) const
inline

The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Definition at line 131 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ SetDashboard() [1/2]

void Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::SetDashboard ( const RegisteredUserDashboardEmbeddingConfiguration value)
inline

The configuration details for providing a dashboard embedding experience.

Definition at line 59 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ SetDashboard() [2/2]

void Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::SetDashboard ( RegisteredUserDashboardEmbeddingConfiguration &&  value)
inline

The configuration details for providing a dashboard embedding experience.

Definition at line 64 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ SetQSearchBar() [1/2]

void Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::SetQSearchBar ( const RegisteredUserQSearchBarEmbeddingConfiguration value)
inline

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview.

Definition at line 268 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ SetQSearchBar() [2/2]

void Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::SetQSearchBar ( RegisteredUserQSearchBarEmbeddingConfiguration &&  value)
inline

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview.

Definition at line 276 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ SetQuickSightConsole() [1/2]

void Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::SetQuickSightConsole ( const RegisteredUserQuickSightConsoleEmbeddingConfiguration value)
inline

The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Definition at line 159 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ SetQuickSightConsole() [2/2]

void Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::SetQuickSightConsole ( RegisteredUserQuickSightConsoleEmbeddingConfiguration &&  value)
inline

The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Definition at line 187 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ WithDashboard() [1/2]

RegisteredUserEmbeddingExperienceConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::WithDashboard ( const RegisteredUserDashboardEmbeddingConfiguration value)
inline

The configuration details for providing a dashboard embedding experience.

Definition at line 69 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ WithDashboard() [2/2]

RegisteredUserEmbeddingExperienceConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::WithDashboard ( RegisteredUserDashboardEmbeddingConfiguration &&  value)
inline

The configuration details for providing a dashboard embedding experience.

Definition at line 74 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ WithQSearchBar() [1/2]

RegisteredUserEmbeddingExperienceConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::WithQSearchBar ( const RegisteredUserQSearchBarEmbeddingConfiguration value)
inline

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview.

Definition at line 284 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ WithQSearchBar() [2/2]

RegisteredUserEmbeddingExperienceConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::WithQSearchBar ( RegisteredUserQSearchBarEmbeddingConfiguration &&  value)
inline

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview.

Definition at line 292 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ WithQuickSightConsole() [1/2]

RegisteredUserEmbeddingExperienceConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::WithQuickSightConsole ( const RegisteredUserQuickSightConsoleEmbeddingConfiguration value)
inline

The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Definition at line 215 of file RegisteredUserEmbeddingExperienceConfiguration.h.

◆ WithQuickSightConsole() [2/2]

RegisteredUserEmbeddingExperienceConfiguration& Aws::QuickSight::Model::RegisteredUserEmbeddingExperienceConfiguration::WithQuickSightConsole ( RegisteredUserQuickSightConsoleEmbeddingConfiguration &&  value)
inline

The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Definition at line 243 of file RegisteredUserEmbeddingExperienceConfiguration.h.


The documentation for this class was generated from the following file: