Aws::QuickSight::Model::GetSessionEmbedUrlRequest Class Reference

#include <GetSessionEmbedUrlRequest.h>

Inheritance diagram for Aws::QuickSight::Model::GetSessionEmbedUrlRequest:

Public Member Functions
	GetSessionEmbedUrlRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
void	AddQueryStringParameters (Aws::Http::URI &uri) const override
const Aws::String &	GetAwsAccountId () const
bool	AwsAccountIdHasBeenSet () const
void	SetAwsAccountId (const Aws::String &value)
void	SetAwsAccountId (Aws::String &&value)
void	SetAwsAccountId (const char *value)
GetSessionEmbedUrlRequest &	WithAwsAccountId (const Aws::String &value)
GetSessionEmbedUrlRequest &	WithAwsAccountId (Aws::String &&value)
GetSessionEmbedUrlRequest &	WithAwsAccountId (const char *value)
const Aws::String &	GetEntryPoint () const
bool	EntryPointHasBeenSet () const
void	SetEntryPoint (const Aws::String &value)
void	SetEntryPoint (Aws::String &&value)
void	SetEntryPoint (const char *value)
GetSessionEmbedUrlRequest &	WithEntryPoint (const Aws::String &value)
GetSessionEmbedUrlRequest &	WithEntryPoint (Aws::String &&value)
GetSessionEmbedUrlRequest &	WithEntryPoint (const char *value)
long long	GetSessionLifetimeInMinutes () const
bool	SessionLifetimeInMinutesHasBeenSet () const
void	SetSessionLifetimeInMinutes (long long value)
GetSessionEmbedUrlRequest &	WithSessionLifetimeInMinutes (long long value)
const Aws::String &	GetUserArn () const
bool	UserArnHasBeenSet () const
void	SetUserArn (const Aws::String &value)
void	SetUserArn (Aws::String &&value)
void	SetUserArn (const char *value)
GetSessionEmbedUrlRequest &	WithUserArn (const Aws::String &value)
GetSessionEmbedUrlRequest &	WithUserArn (Aws::String &&value)
GetSessionEmbedUrlRequest &	WithUserArn (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 25 of file GetSessionEmbedUrlRequest.h.

Constructor & Destructor Documentation

GetSessionEmbedUrlRequest()

Aws::QuickSight::Model::GetSessionEmbedUrlRequest::GetSessionEmbedUrlRequest

(

)

Member Function Documentation

AddQueryStringParameters()

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::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::GetSessionEmbedUrlRequest::AwsAccountIdHasBeenSet ( ) const

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 49 of file GetSessionEmbedUrlRequest.h.

EntryPointHasBeenSet()

bool Aws::QuickSight::Model::GetSessionEmbedUrlRequest::EntryPointHasBeenSet ( ) const

inline

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 QuickSight console URL of the dashboard

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

Definition at line 106 of file GetSessionEmbedUrlRequest.h.

GetAwsAccountId()

const Aws::String& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::GetAwsAccountId ( ) const

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 44 of file GetSessionEmbedUrlRequest.h.

GetEntryPoint()

const Aws::String& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::GetEntryPoint ( ) const

inline

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 QuickSight console URL of the dashboard

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

Definition at line 93 of file GetSessionEmbedUrlRequest.h.

GetServiceRequestName()

virtual const char* Aws::QuickSight::Model::GetSessionEmbedUrlRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file GetSessionEmbedUrlRequest.h.

GetSessionLifetimeInMinutes()

long long Aws::QuickSight::Model::GetSessionEmbedUrlRequest::GetSessionLifetimeInMinutes ( ) const

inline

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

Definition at line 191 of file GetSessionEmbedUrlRequest.h.

GetUserArn()

const Aws::String& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::GetUserArn ( ) const

inline

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. AWS Identity and Access Management (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 223 of file GetSessionEmbedUrlRequest.h.

SerializePayload()

Aws::String Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SessionLifetimeInMinutesHasBeenSet()

bool Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SessionLifetimeInMinutesHasBeenSet ( ) const

inline

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

Definition at line 197 of file GetSessionEmbedUrlRequest.h.

SetAwsAccountId() [1/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SetAwsAccountId ( Aws::String &&  value )

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 59 of file GetSessionEmbedUrlRequest.h.

SetAwsAccountId() [2/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SetAwsAccountId ( const Aws::String &  value )

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 54 of file GetSessionEmbedUrlRequest.h.

SetAwsAccountId() [3/3]

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

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 64 of file GetSessionEmbedUrlRequest.h.

SetEntryPoint() [1/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SetEntryPoint ( Aws::String &&  value )

inline

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 QuickSight console URL of the dashboard

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

Definition at line 132 of file GetSessionEmbedUrlRequest.h.

SetEntryPoint() [2/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SetEntryPoint ( const Aws::String &  value )

inline

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 QuickSight console URL of the dashboard

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

Definition at line 119 of file GetSessionEmbedUrlRequest.h.

SetEntryPoint() [3/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SetEntryPoint ( const char *  value )

inline

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 QuickSight console URL of the dashboard

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

Definition at line 145 of file GetSessionEmbedUrlRequest.h.

SetSessionLifetimeInMinutes()

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::SetSessionLifetimeInMinutes ( long long  value )

inline

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

Definition at line 203 of file GetSessionEmbedUrlRequest.h.

SetUserArn() [1/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::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 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. AWS Identity and Access Management (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 262 of file GetSessionEmbedUrlRequest.h.

SetUserArn() [2/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::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 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. AWS Identity and Access Management (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 249 of file GetSessionEmbedUrlRequest.h.

SetUserArn() [3/3]

void Aws::QuickSight::Model::GetSessionEmbedUrlRequest::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 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. AWS Identity and Access Management (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 275 of file GetSessionEmbedUrlRequest.h.

UserArnHasBeenSet()

bool Aws::QuickSight::Model::GetSessionEmbedUrlRequest::UserArnHasBeenSet ( ) const

inline

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. AWS Identity and Access Management (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 236 of file GetSessionEmbedUrlRequest.h.

WithAwsAccountId() [1/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::WithAwsAccountId ( Aws::String &&  value )

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 74 of file GetSessionEmbedUrlRequest.h.

WithAwsAccountId() [2/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::WithAwsAccountId ( const Aws::String &  value )

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 69 of file GetSessionEmbedUrlRequest.h.

WithAwsAccountId() [3/3]

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

inline

The ID for the AWS account associated with your QuickSight subscription.

Definition at line 79 of file GetSessionEmbedUrlRequest.h.

WithEntryPoint() [1/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::WithEntryPoint ( Aws::String &&  value )

inline

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 QuickSight console URL of the dashboard

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

Definition at line 171 of file GetSessionEmbedUrlRequest.h.

WithEntryPoint() [2/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::WithEntryPoint ( const Aws::String &  value )

inline

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 QuickSight console URL of the dashboard

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

Definition at line 158 of file GetSessionEmbedUrlRequest.h.

WithEntryPoint() [3/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::WithEntryPoint ( const char *  value )

inline

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 QuickSight console URL of the dashboard

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

Definition at line 184 of file GetSessionEmbedUrlRequest.h.

WithSessionLifetimeInMinutes()

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::WithSessionLifetimeInMinutes ( long long  value )

inline

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

Definition at line 209 of file GetSessionEmbedUrlRequest.h.

WithUserArn() [1/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::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 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. AWS Identity and Access Management (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 301 of file GetSessionEmbedUrlRequest.h.

WithUserArn() [2/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::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 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. AWS Identity and Access Management (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 288 of file GetSessionEmbedUrlRequest.h.

WithUserArn() [3/3]

GetSessionEmbedUrlRequest& Aws::QuickSight::Model::GetSessionEmbedUrlRequest::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 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. AWS Identity and Access Management (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 GetSessionEmbedUrlRequest.h.

---

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

• aws-cpp-sdk-quicksight/include/aws/quicksight/model/GetSessionEmbedUrlRequest.h