AWS SDK for C++  1.8.51
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 IdentityTypeGetIdentityType () const
 
bool IdentityTypeHasBeenSet () const
 
void SetIdentityType (const IdentityType &value)
 
void SetIdentityType (IdentityType &&value)
 
GetDashboardEmbedUrlRequestWithIdentityType (const IdentityType &value)
 
GetDashboardEmbedUrlRequestWithIdentityType (IdentityType &&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)
 
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)
 
- 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 26 of file GetDashboardEmbedUrlRequest.h.

Constructor & Destructor Documentation

◆ GetDashboardEmbedUrlRequest()

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

Member Function Documentation

◆ 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 52 of file GetDashboardEmbedUrlRequest.h.

◆ DashboardIdHasBeenSet()

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

The ID for the dashboard, also added to the IAM policy.

Definition at line 99 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 46 of file GetDashboardEmbedUrlRequest.h.

◆ GetDashboardId()

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

The ID for the dashboard, also added to the IAM policy.

Definition at line 94 of file GetDashboardEmbedUrlRequest.h.

◆ GetIdentityType()

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

The authentication method that the user uses to sign in.

Definition at line 135 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 217 of file GetDashboardEmbedUrlRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 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 167 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 192 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 248 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 140 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 223 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 173 of file GetDashboardEmbedUrlRequest.h.

◆ SetAwsAccountId() [1/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 58 of file GetDashboardEmbedUrlRequest.h.

◆ SetAwsAccountId() [2/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 64 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 70 of file GetDashboardEmbedUrlRequest.h.

◆ SetDashboardId() [1/3]

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

The ID for the dashboard, also added to the IAM policy.

Definition at line 104 of file GetDashboardEmbedUrlRequest.h.

◆ SetDashboardId() [2/3]

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

The ID for the dashboard, also added to the IAM policy.

Definition at line 109 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 IAM policy.

Definition at line 114 of file GetDashboardEmbedUrlRequest.h.

◆ SetIdentityType() [1/2]

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

The authentication method that the user uses to sign in.

Definition at line 145 of file GetDashboardEmbedUrlRequest.h.

◆ SetIdentityType() [2/2]

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

The authentication method that the user uses to sign in.

Definition at line 150 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 229 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 179 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 204 of file GetDashboardEmbedUrlRequest.h.

◆ SetUserArn() [1/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 272 of file GetDashboardEmbedUrlRequest.h.

◆ SetUserArn() [2/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 284 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 296 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 198 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 260 of file GetDashboardEmbedUrlRequest.h.

◆ WithAwsAccountId() [1/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 76 of file GetDashboardEmbedUrlRequest.h.

◆ WithAwsAccountId() [2/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 82 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 88 of file GetDashboardEmbedUrlRequest.h.

◆ WithDashboardId() [1/3]

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

The ID for the dashboard, also added to the IAM policy.

Definition at line 119 of file GetDashboardEmbedUrlRequest.h.

◆ WithDashboardId() [2/3]

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

The ID for the dashboard, also added to the IAM policy.

Definition at line 124 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 IAM policy.

Definition at line 129 of file GetDashboardEmbedUrlRequest.h.

◆ WithIdentityType() [1/2]

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

The authentication method that the user uses to sign in.

Definition at line 155 of file GetDashboardEmbedUrlRequest.h.

◆ WithIdentityType() [2/2]

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

The authentication method that the user uses to sign in.

Definition at line 160 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 235 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 185 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 210 of file GetDashboardEmbedUrlRequest.h.

◆ WithUserArn() [1/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 308 of file GetDashboardEmbedUrlRequest.h.

◆ WithUserArn() [2/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 320 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 332 of file GetDashboardEmbedUrlRequest.h.


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