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

#include <GetDashboardEmbedUrlRequest.h>

+ Inheritance diagram for Aws::QuickSight::Model::GetDashboardEmbedUrlRequest:

Public Member Functions

 GetDashboardEmbedUrlRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetAwsAccountId () const
 
bool AwsAccountIdHasBeenSet () const
 
void SetAwsAccountId (const Aws::String &value)
 
void SetAwsAccountId (Aws::String &&value)
 
void SetAwsAccountId (const char *value)
 
GetDashboardEmbedUrlRequestWithAwsAccountId (const Aws::String &value)
 
GetDashboardEmbedUrlRequestWithAwsAccountId (Aws::String &&value)
 
GetDashboardEmbedUrlRequestWithAwsAccountId (const char *value)
 
const Aws::StringGetDashboardId () const
 
bool DashboardIdHasBeenSet () const
 
void SetDashboardId (const Aws::String &value)
 
void SetDashboardId (Aws::String &&value)
 
void SetDashboardId (const char *value)
 
GetDashboardEmbedUrlRequestWithDashboardId (const Aws::String &value)
 
GetDashboardEmbedUrlRequestWithDashboardId (Aws::String &&value)
 
GetDashboardEmbedUrlRequestWithDashboardId (const char *value)
 
const EmbeddingIdentityTypeGetIdentityType () const
 
bool IdentityTypeHasBeenSet () const
 
void SetIdentityType (const EmbeddingIdentityType &value)
 
void SetIdentityType (EmbeddingIdentityType &&value)
 
GetDashboardEmbedUrlRequestWithIdentityType (const EmbeddingIdentityType &value)
 
GetDashboardEmbedUrlRequestWithIdentityType (EmbeddingIdentityType &&value)
 
long long GetSessionLifetimeInMinutes () const
 
bool SessionLifetimeInMinutesHasBeenSet () const
 
void SetSessionLifetimeInMinutes (long long value)
 
GetDashboardEmbedUrlRequestWithSessionLifetimeInMinutes (long long value)
 
bool GetUndoRedoDisabled () const
 
bool UndoRedoDisabledHasBeenSet () const
 
void SetUndoRedoDisabled (bool value)
 
GetDashboardEmbedUrlRequestWithUndoRedoDisabled (bool value)
 
bool GetResetDisabled () const
 
bool ResetDisabledHasBeenSet () const
 
void SetResetDisabled (bool value)
 
GetDashboardEmbedUrlRequestWithResetDisabled (bool value)
 
bool GetStatePersistenceEnabled () const
 
bool StatePersistenceEnabledHasBeenSet () const
 
void SetStatePersistenceEnabled (bool value)
 
GetDashboardEmbedUrlRequestWithStatePersistenceEnabled (bool value)
 
const Aws::StringGetUserArn () const
 
bool UserArnHasBeenSet () const
 
void SetUserArn (const Aws::String &value)
 
void SetUserArn (Aws::String &&value)
 
void SetUserArn (const char *value)
 
GetDashboardEmbedUrlRequestWithUserArn (const Aws::String &value)
 
GetDashboardEmbedUrlRequestWithUserArn (Aws::String &&value)
 
GetDashboardEmbedUrlRequestWithUserArn (const char *value)
 
const Aws::StringGetNamespace () const
 
bool NamespaceHasBeenSet () const
 
void SetNamespace (const Aws::String &value)
 
void SetNamespace (Aws::String &&value)
 
void SetNamespace (const char *value)
 
GetDashboardEmbedUrlRequestWithNamespace (const Aws::String &value)
 
GetDashboardEmbedUrlRequestWithNamespace (Aws::String &&value)
 
GetDashboardEmbedUrlRequestWithNamespace (const char *value)
 
const Aws::Vector< Aws::String > & GetAdditionalDashboardIds () const
 
bool AdditionalDashboardIdsHasBeenSet () const
 
void SetAdditionalDashboardIds (const Aws::Vector< Aws::String > &value)
 
void SetAdditionalDashboardIds (Aws::Vector< Aws::String > &&value)
 
GetDashboardEmbedUrlRequestWithAdditionalDashboardIds (const Aws::Vector< Aws::String > &value)
 
GetDashboardEmbedUrlRequestWithAdditionalDashboardIds (Aws::Vector< Aws::String > &&value)
 
GetDashboardEmbedUrlRequestAddAdditionalDashboardIds (const Aws::String &value)
 
GetDashboardEmbedUrlRequestAddAdditionalDashboardIds (Aws::String &&value)
 
GetDashboardEmbedUrlRequestAddAdditionalDashboardIds (const char *value)
 
- Public Member Functions inherited from Aws::QuickSight::QuickSightRequest
virtual ~QuickSightRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::QuickSight::QuickSightRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file GetDashboardEmbedUrlRequest.h.

Constructor & Destructor Documentation

◆ GetDashboardEmbedUrlRequest()

Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetDashboardEmbedUrlRequest ( )

Member Function Documentation

◆ AddAdditionalDashboardIds() [1/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::AddAdditionalDashboardIds ( Aws::String &&  value)
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 516 of file GetDashboardEmbedUrlRequest.h.

◆ AddAdditionalDashboardIds() [2/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::AddAdditionalDashboardIds ( const Aws::String value)
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 506 of file GetDashboardEmbedUrlRequest.h.

◆ AddAdditionalDashboardIds() [3/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::AddAdditionalDashboardIds ( const char *  value)
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 526 of file GetDashboardEmbedUrlRequest.h.

◆ AdditionalDashboardIdsHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::AdditionalDashboardIdsHasBeenSet ( ) const
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 456 of file GetDashboardEmbedUrlRequest.h.

◆ AddQueryStringParameters()

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ AwsAccountIdHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::AwsAccountIdHasBeenSet ( ) const
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 53 of file GetDashboardEmbedUrlRequest.h.

◆ DashboardIdHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::DashboardIdHasBeenSet ( ) const
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 102 of file GetDashboardEmbedUrlRequest.h.

◆ GetAdditionalDashboardIds()

const Aws::Vector<Aws::String>& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetAdditionalDashboardIds ( ) const
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 446 of file GetDashboardEmbedUrlRequest.h.

◆ GetAwsAccountId()

const Aws::String& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetAwsAccountId ( ) const
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 47 of file GetDashboardEmbedUrlRequest.h.

◆ GetDashboardId()

const Aws::String& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetDashboardId ( ) const
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 96 of file GetDashboardEmbedUrlRequest.h.

◆ GetIdentityType()

const EmbeddingIdentityType& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetIdentityType ( ) const
inline

The authentication method that the user uses to sign in.

Definition at line 144 of file GetDashboardEmbedUrlRequest.h.

◆ GetNamespace()

const Aws::String& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetNamespace ( ) const
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 393 of file GetDashboardEmbedUrlRequest.h.

◆ GetResetDisabled()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetResetDisabled ( ) const
inline

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Definition at line 226 of file GetDashboardEmbedUrlRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file GetDashboardEmbedUrlRequest.h.

◆ GetSessionLifetimeInMinutes()

long long Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetSessionLifetimeInMinutes ( ) const
inline

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

Definition at line 176 of file GetDashboardEmbedUrlRequest.h.

◆ GetStatePersistenceEnabled()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetStatePersistenceEnabled ( ) const
inline

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Definition at line 256 of file GetDashboardEmbedUrlRequest.h.

◆ GetUndoRedoDisabled()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetUndoRedoDisabled ( ) const
inline

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Definition at line 201 of file GetDashboardEmbedUrlRequest.h.

◆ GetUserArn()

const Aws::String& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::GetUserArn ( ) const
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 302 of file GetDashboardEmbedUrlRequest.h.

◆ IdentityTypeHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::IdentityTypeHasBeenSet ( ) const
inline

The authentication method that the user uses to sign in.

Definition at line 149 of file GetDashboardEmbedUrlRequest.h.

◆ NamespaceHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::NamespaceHasBeenSet ( ) const
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 399 of file GetDashboardEmbedUrlRequest.h.

◆ ResetDisabledHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::ResetDisabledHasBeenSet ( ) const
inline

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Definition at line 232 of file GetDashboardEmbedUrlRequest.h.

◆ SerializePayload()

Aws::String Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SessionLifetimeInMinutesHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SessionLifetimeInMinutesHasBeenSet ( ) const
inline

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

Definition at line 182 of file GetDashboardEmbedUrlRequest.h.

◆ SetAdditionalDashboardIds() [1/2]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetAdditionalDashboardIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 476 of file GetDashboardEmbedUrlRequest.h.

◆ SetAdditionalDashboardIds() [2/2]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetAdditionalDashboardIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 466 of file GetDashboardEmbedUrlRequest.h.

◆ SetAwsAccountId() [1/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetAwsAccountId ( Aws::String &&  value)
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 65 of file GetDashboardEmbedUrlRequest.h.

◆ SetAwsAccountId() [2/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetAwsAccountId ( const Aws::String value)
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 59 of file GetDashboardEmbedUrlRequest.h.

◆ SetAwsAccountId() [3/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetAwsAccountId ( const char *  value)
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 71 of file GetDashboardEmbedUrlRequest.h.

◆ SetDashboardId() [1/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetDashboardId ( Aws::String &&  value)
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 114 of file GetDashboardEmbedUrlRequest.h.

◆ SetDashboardId() [2/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetDashboardId ( const Aws::String value)
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 108 of file GetDashboardEmbedUrlRequest.h.

◆ SetDashboardId() [3/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetDashboardId ( const char *  value)
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 120 of file GetDashboardEmbedUrlRequest.h.

◆ SetIdentityType() [1/2]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetIdentityType ( const EmbeddingIdentityType value)
inline

The authentication method that the user uses to sign in.

Definition at line 154 of file GetDashboardEmbedUrlRequest.h.

◆ SetIdentityType() [2/2]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetIdentityType ( EmbeddingIdentityType &&  value)
inline

The authentication method that the user uses to sign in.

Definition at line 159 of file GetDashboardEmbedUrlRequest.h.

◆ SetNamespace() [1/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetNamespace ( Aws::String &&  value)
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 411 of file GetDashboardEmbedUrlRequest.h.

◆ SetNamespace() [2/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetNamespace ( const Aws::String value)
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 405 of file GetDashboardEmbedUrlRequest.h.

◆ SetNamespace() [3/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetNamespace ( const char *  value)
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 417 of file GetDashboardEmbedUrlRequest.h.

◆ SetResetDisabled()

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetResetDisabled ( bool  value)
inline

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Definition at line 238 of file GetDashboardEmbedUrlRequest.h.

◆ SetSessionLifetimeInMinutes()

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetSessionLifetimeInMinutes ( long long  value)
inline

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

Definition at line 188 of file GetDashboardEmbedUrlRequest.h.

◆ SetStatePersistenceEnabled()

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetStatePersistenceEnabled ( bool  value)
inline

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Definition at line 278 of file GetDashboardEmbedUrlRequest.h.

◆ SetUndoRedoDisabled()

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetUndoRedoDisabled ( bool  value)
inline

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Definition at line 213 of file GetDashboardEmbedUrlRequest.h.

◆ SetUserArn() [1/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetUserArn ( Aws::String &&  value)
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 338 of file GetDashboardEmbedUrlRequest.h.

◆ SetUserArn() [2/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetUserArn ( const Aws::String value)
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 326 of file GetDashboardEmbedUrlRequest.h.

◆ SetUserArn() [3/3]

void Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::SetUserArn ( const char *  value)
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 350 of file GetDashboardEmbedUrlRequest.h.

◆ StatePersistenceEnabledHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::StatePersistenceEnabledHasBeenSet ( ) const
inline

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Definition at line 267 of file GetDashboardEmbedUrlRequest.h.

◆ UndoRedoDisabledHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::UndoRedoDisabledHasBeenSet ( ) const
inline

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Definition at line 207 of file GetDashboardEmbedUrlRequest.h.

◆ UserArnHasBeenSet()

bool Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::UserArnHasBeenSet ( ) const
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 314 of file GetDashboardEmbedUrlRequest.h.

◆ WithAdditionalDashboardIds() [1/2]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithAdditionalDashboardIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 496 of file GetDashboardEmbedUrlRequest.h.

◆ WithAdditionalDashboardIds() [2/2]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithAdditionalDashboardIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.

Definition at line 486 of file GetDashboardEmbedUrlRequest.h.

◆ WithAwsAccountId() [1/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithAwsAccountId ( Aws::String &&  value)
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 83 of file GetDashboardEmbedUrlRequest.h.

◆ WithAwsAccountId() [2/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithAwsAccountId ( const Aws::String value)
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 77 of file GetDashboardEmbedUrlRequest.h.

◆ WithAwsAccountId() [3/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithAwsAccountId ( const char *  value)
inline

The ID for the AWS account that contains the dashboard that you're embedding.

Definition at line 89 of file GetDashboardEmbedUrlRequest.h.

◆ WithDashboardId() [1/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithDashboardId ( Aws::String &&  value)
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 132 of file GetDashboardEmbedUrlRequest.h.

◆ WithDashboardId() [2/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithDashboardId ( const Aws::String value)
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 126 of file GetDashboardEmbedUrlRequest.h.

◆ WithDashboardId() [3/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithDashboardId ( const char *  value)
inline

The ID for the dashboard, also added to the AWS Identity and Access Management (IAM) policy.

Definition at line 138 of file GetDashboardEmbedUrlRequest.h.

◆ WithIdentityType() [1/2]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithIdentityType ( const EmbeddingIdentityType value)
inline

The authentication method that the user uses to sign in.

Definition at line 164 of file GetDashboardEmbedUrlRequest.h.

◆ WithIdentityType() [2/2]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithIdentityType ( EmbeddingIdentityType &&  value)
inline

The authentication method that the user uses to sign in.

Definition at line 169 of file GetDashboardEmbedUrlRequest.h.

◆ WithNamespace() [1/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithNamespace ( Aws::String &&  value)
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 429 of file GetDashboardEmbedUrlRequest.h.

◆ WithNamespace() [2/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithNamespace ( const Aws::String value)
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 423 of file GetDashboardEmbedUrlRequest.h.

◆ WithNamespace() [3/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithNamespace ( const char *  value)
inline

The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "<code>default</code>".

Definition at line 435 of file GetDashboardEmbedUrlRequest.h.

◆ WithResetDisabled()

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithResetDisabled ( bool  value)
inline

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

Definition at line 244 of file GetDashboardEmbedUrlRequest.h.

◆ WithSessionLifetimeInMinutes()

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithSessionLifetimeInMinutes ( long long  value)
inline

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

Definition at line 194 of file GetDashboardEmbedUrlRequest.h.

◆ WithStatePersistenceEnabled()

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithStatePersistenceEnabled ( bool  value)
inline

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

Definition at line 289 of file GetDashboardEmbedUrlRequest.h.

◆ WithUndoRedoDisabled()

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithUndoRedoDisabled ( bool  value)
inline

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

Definition at line 219 of file GetDashboardEmbedUrlRequest.h.

◆ WithUserArn() [1/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithUserArn ( Aws::String &&  value)
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 374 of file GetDashboardEmbedUrlRequest.h.

◆ WithUserArn() [2/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithUserArn ( const Aws::String value)
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 362 of file GetDashboardEmbedUrlRequest.h.

◆ WithUserArn() [3/3]

GetDashboardEmbedUrlRequest& Aws::QuickSight::Model::GetDashboardEmbedUrlRequest::WithUserArn ( const char *  value)
inline

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

  • Active Directory (AD) users or group members

  • Invited nonfederated users

  • 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.

Definition at line 386 of file GetDashboardEmbedUrlRequest.h.


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