com.amazonaws.services.quicksight.model

Class GetSessionEmbedUrlRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.GetSessionEmbedUrlRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSessionEmbedUrlRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetSessionEmbedUrlRequest()

Method Summary

Modifier and Type	Method and Description
GetSessionEmbedUrlRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
String	getEntryPoint() The URL you use to access the embedded session.
Long	getSessionLifetimeInMinutes() How many minutes the session is valid.
String	getUserArn() The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
void	setEntryPoint(String entryPoint) The URL you use to access the embedded session.
void	setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
void	setUserArn(String userArn) The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.
String	toString() Returns a string representation of this object.
GetSessionEmbedUrlRequest	withAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
GetSessionEmbedUrlRequest	withEntryPoint(String entryPoint) The URL you use to access the embedded session.
GetSessionEmbedUrlRequest	withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) How many minutes the session is valid.
GetSessionEmbedUrlRequest	withUserArn(String userArn) The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSessionEmbedUrlRequest

public GetSessionEmbedUrlRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Parameters:

awsAccountId - The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

getAwsAccountId

public String getAwsAccountId()

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Returns:

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

withAwsAccountId

public GetSessionEmbedUrlRequest withAwsAccountId(String awsAccountId)

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Parameters:

awsAccountId - The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEntryPoint

public void setEntryPoint(String entryPoint)

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

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

Parameters:

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

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

getEntryPoint

public String getEntryPoint()

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

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

Returns:

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

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

withEntryPoint

public GetSessionEmbedUrlRequest withEntryPoint(String entryPoint)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSessionLifetimeInMinutes

public void setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

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

Parameters:

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

getSessionLifetimeInMinutes

public Long getSessionLifetimeInMinutes()

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

Returns:

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

withSessionLifetimeInMinutes

public GetSessionEmbedUrlRequest withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserArn

public void setUserArn(String userArn)

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

Parameters:

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

getUserArn

public String getUserArn()

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

Returns:

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

withUserArn

public GetSessionEmbedUrlRequest withUserArn(String userArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetSessionEmbedUrlRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()